apigateway_get_gateway_responses: Gets the GatewayResponses collection on the given RestApi

Description Usage Arguments Value Request syntax

View source: R/apigateway_operations.R

Description

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.

Usage

1
apigateway_get_gateway_responses(restApiId, position, limit)

Arguments

restApiId

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

position

The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

limit

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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
list(
  position = "string",
  items = list(
    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

1
2
3
4
5
svc$get_gateway_responses(
  restApiId = "string",
  position = "string",
  limit = 123
)

paws.networking documentation built on Aug. 23, 2021, 9:07 a.m.