[ aws . apigateway ]

put-gateway-response

Description

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-gateway-response
--rest-api-id <value>
--response-type <value>
[--status-code <value>]
[--response-parameters <value>]
[--response-templates <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--rest-api-id (string)

[Required] The string identifier of the associated RestApi .

--response-type (string)

[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

--status-code (string) The HTTP status code of the GatewayResponse .

--response-parameters (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--response-templates (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

responseType -> (string)

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

statusCode -> (string)

The HTTP status code for this GatewayResponse .

responseParameters -> (map)

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

key -> (string)

value -> (string)

responseTemplates -> (map)

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

key -> (string)

value -> (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.