get_integration_responses

ApiGatewayV2.Client.get_integration_responses(**kwargs)

Gets the IntegrationResponses for an Integration.

See also: AWS API Documentation

Request Syntax

response = client.get_integration_responses(
    ApiId='string',
    IntegrationId='string',
    MaxResults='string',
    NextToken='string'
)

Parameters

• ApiId (string) --

  [REQUIRED]

  The API identifier.

• IntegrationId (string) --

  [REQUIRED]

  The integration ID.

• MaxResults (string) -- The maximum number of elements to be returned for this resource.
• NextToken (string) -- The next page of elements from this collection. Not valid for the last element of the collection.

Return type

dict

Returns

Response Syntax

{
    'Items': [
        {
            'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
            'IntegrationResponseId': 'string',
            'IntegrationResponseKey': 'string',
            'ResponseParameters': {
                'string': 'string'
            },
            'ResponseTemplates': {
                'string': 'string'
            },
            'TemplateSelectionExpression': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  Success

  • Items (list) --

    The elements from this collection.

    • (dict) --

      Represents an integration response.

      • ContentHandlingStrategy (string) --

        Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

        CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

        CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

        If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

      • IntegrationResponseId (string) --

        The integration response ID.

      • IntegrationResponseKey (string) --

        The integration response key.

      • ResponseParameters (dict) --

        A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

        • (string) --

          • (string) --

            A string with a length between [1-512].

      • ResponseTemplates (dict) --

        The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

        • (string) --

          • (string) --

            A string with a length between [0-32768].

      • TemplateSelectionExpression (string) --

        The template selection expressions for the integration response.

  • NextToken (string) --

    The next page of elements from this collection. Not valid for the last element of the collection.

Exceptions

• ApiGatewayV2.Client.exceptions.NotFoundException
• ApiGatewayV2.Client.exceptions.TooManyRequestsException
• ApiGatewayV2.Client.exceptions.BadRequestException