paws.networking (version 0.1.11)

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

Description

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

Usage

apigateway_put_gateway_response(restApiId, responseType, statusCode,
  responseParameters, responseTemplates)

Arguments

restApiId

[required] [Required] The string identifier of the associated RestApi.

responseType

[required] [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

statusCode

The HTTP status code of the GatewayResponse.

responseParameters

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

responseTemplates

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

Value

A list with the following syntax:

list(
  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",
  statusCode = "string",
  responseParameters = list(
    "string"
  ),
  responseTemplates = list(
    "string"
  ),
  defaultResponse = TRUE|FALSE
)

Request syntax

svc$put_gateway_response(
  restApiId = "string",
  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",
  statusCode = "string",
  responseParameters = list(
    "string"
  ),
  responseTemplates = list(
    "string"
  )
)