You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::GetGatewayResponseRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetGatewayResponseRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  rest_api_id: "String", # required
  response_type: "DEFAULT_4XX", # required, accepts 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
}

Gets a GatewayResponse of a specified response type on the given RestApi.

Instance Attribute Summary collapse

Instance Attribute Details

#response_typeString

[Required] The response type of the associated GatewayResponse. Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPE

Possible values:

  • 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

Returns:

  • (String)

    [Required] The response type of the associated GatewayResponse.

#rest_api_idString

[Required] The string identifier of the associated RestApi.

Returns:

  • (String)

    [Required] The string identifier of the associated RestApi.