AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . apigateway ]
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
See also: AWS API Documentation
put-gateway-response
--rest-api-id <value>
--response-type <value>
[--status-code <value>]
[--response-parameters <value>]
[--response-templates <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--rest-api-id
(string)
The string identifier of the associated RestApi.
--response-type
(string)
The response type of the associated GatewayResponse
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
WAF_FILTERED
--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
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI 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.
--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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
responseType -> (string)
The response type of the associated GatewayResponse.
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.