APIGateway / Client / get_gateway_responses

get_gateway_responses#

APIGateway.Client.get_gateway_responses(**kwargs)#

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

See also: AWS API Documentation

Request Syntax

response = client.get_gateway_responses(
    restApiId='string',
    position='string',
    limit=123
)
Parameters:

  • restApiId (string) –

    [REQUIRED]

    The string identifier of the associated RestApi.

  • position (string) – The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

  • limit (integer) – The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

Return type:

dict

Returns:

Response Syntax

{
    'position': 'string',
    'items': [
        {
            'responseType': 'DEFAULT_4XX'|'DEFAULT_5XX'|'RESOURCE_NOT_FOUND'|'UNAUTHORIZED'|'INVALID_API_KEY'|'ACCESS_DENIED'|'AUTHORIZER_FAILURE'|'AUTHORIZER_CONFIGURATION_ERROR'|'INVALID_SIGNATURE'|'EXPIRED_TOKEN'|'MISSING_AUTHENTICATION_TOKEN'|'INTEGRATION_FAILURE'|'INTEGRATION_TIMEOUT'|'API_CONFIGURATION_ERROR'|'UNSUPPORTED_MEDIA_TYPE'|'BAD_REQUEST_PARAMETERS'|'BAD_REQUEST_BODY'|'REQUEST_TOO_LARGE'|'THROTTLED'|'QUOTA_EXCEEDED'|'WAF_FILTERED',
            'statusCode': 'string',
            'responseParameters': {
                'string': 'string'
            },
            'responseTemplates': {
                'string': 'string'
            },
            'defaultResponse': True|False
        },
    ]
}

Response Structure

  • (dict) –

    The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.

    • position (string) –

    • items (list) –

      Returns the entire collection, because of no pagination support.

      • (dict) –

        A gateway response of a given response type and status code, with optional response parameters and mapping templates.

        • responseType (string) –

          The response type of the associated GatewayResponse.

        • statusCode (string) –

          The HTTP status code for this GatewayResponse.

        • responseParameters (dict) –

          Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

          • (string) –

            • (string) –

        • responseTemplates (dict) –

          Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

          • (string) –

            • (string) –

        • defaultResponse (boolean) –

          A Boolean flag to indicate whether this GatewayResponse is the default gateway response ( true) or not ( false). A default gateway response is one generated by API Gateway without any customization by an API developer.

Exceptions

  • APIGateway.Client.exceptions.BadRequestException

  • APIGateway.Client.exceptions.NotFoundException

  • APIGateway.Client.exceptions.UnauthorizedException

  • APIGateway.Client.exceptions.TooManyRequestsException