Skip to content

Get Integration

apigateway_get_integration R Documentation

Get the integration settings

Description

Get the integration settings.

Usage

apigateway_get_integration(restApiId, resourceId, httpMethod)

Arguments

restApiId

[required] The string identifier of the associated RestApi.

resourceId

[required] Specifies a get integration request's resource identifier

httpMethod

[required] Specifies a get integration request's HTTP method.

Value

A list with the following syntax:

list(
  type = "HTTP"|"AWS"|"MOCK"|"HTTP_PROXY"|"AWS_PROXY",
  httpMethod = "string",
  uri = "string",
  connectionType = "INTERNET"|"VPC_LINK",
  connectionId = "string",
  credentials = "string",
  requestParameters = list(
    "string"
  ),
  requestTemplates = list(
    "string"
  ),
  passthroughBehavior = "string",
  contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT",
  timeoutInMillis = 123,
  cacheNamespace = "string",
  cacheKeyParameters = list(
    "string"
  ),
  integrationResponses = list(
    list(
      statusCode = "string",
      selectionPattern = "string",
      responseParameters = list(
        "string"
      ),
      responseTemplates = list(
        "string"
      ),
      contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT"
    )
  ),
  tlsConfig = list(
    insecureSkipVerification = TRUE|FALSE
  )
)

Request syntax

svc$get_integration(
  restApiId = "string",
  resourceId = "string",
  httpMethod = "string"
)