Type Members

1.  class APIGateway extends Object

   Annotations

   @RawJSType() @native() @JSImport( "aws-sdk" , "APIGateway" )

2.  implicit final class APIGatewayOps extends AnyVal
3.  trait AccessLogSettings extends Object

   Access log settings, including the access log format and access log destination ARN.

   Access log settings, including the access log format and access log destination ARN.

   Annotations

   @RawJSType() @native()

4.  trait Account extends Object

   Represents an AWS account that is associated with API Gateway.

   Represents an AWS account that is associated with API Gateway.

   To view the account info, call GET on this resource.

   Error Codes

   The following exception may be thrown when the request fails. * UnauthorizedException * NotFoundException * TooManyRequestsException For detailed error code information, including the corresponding HTTP Status Codes, see Gateway Error Codes

   Example: Get the information about an account.

   Request

   GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

   Response

   The successful response returns a 200 OK status code and a payload similar to the following:

   { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html", "name": "account", "templated": true }, "self": { "href": "/account" }, "account:update": { "href": "/account" } }, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": { "rateLimit": 500, "burstLimit": 1000 } }

   In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.

   { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html", "name": "account", "templated": true }, "self": { "href": "/account" }, "account:update": { "href": "/account" } }, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": { "rateLimit": 500, "burstLimit": 1000 } } }}}

   Annotations

   @RawJSType() @native()

   See also

   Gateway Limits Guide, CLI

5.  trait ApiKey extends Object

   A resource that can be distributed to callers for executing Method resources that require an API key.

   A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

   Annotations

   @RawJSType() @native()

   See also

   API Keys

6.  trait ApiKeyIds extends Object

   The identifier of an ApiKey used in a UsagePlan.

   The identifier of an ApiKey used in a UsagePlan.

   Annotations

   @RawJSType() @native()

7.  type ApiKeySourceType = String
8.  trait ApiKeys extends Object

   Represents a collection of API keys as represented by an ApiKeys resource.

   Represents a collection of API keys as represented by an ApiKeys resource.

   Annotations

   @RawJSType() @native()

   See also

   API Keys

9.  type ApiKeysFormat = String
10.  trait ApiStage extends Object

    API stage name of the associated API stage in a usage plan.

    API stage name of the associated API stage in a usage plan.

    Annotations

    @RawJSType() @native()

11.  trait Authorizer extends Object

    Represents an authorization layer for methods.

    Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

    Annotations

    @RawJSType() @native()

    See also

    custom authorization

12.  type AuthorizerType = String
13.  trait Authorizers extends Object

    Represents a collection of Authorizer resources.

    Represents a collection of Authorizer resources.

    Annotations

    @RawJSType() @native()

    See also

    custom authorization

14.  trait BasePathMapping extends Object

    Represents the base path that callers of the API must provide as part of the URL after the domain name.

    Represents the base path that callers of the API must provide as part of the URL after the domain name.

    A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.

    Annotations

    @RawJSType() @native()

    See also

    Custom Domain Names

15.  trait BasePathMappings extends Object

    Represents a collection of BasePathMapping resources.

    Represents a collection of BasePathMapping resources.

    Annotations

    @RawJSType() @native()

    See also

    Custom Domain Names

16.  type Blob = |[|[|[|[Buffer, Readable], TypedArray[_, _]], Array[Byte]], String]
17.  type CacheClusterSize = String
18.  type CacheClusterStatus = String
19.  trait CanarySettings extends Object

    Configuration settings of a canary deployment.

    Configuration settings of a canary deployment.

    Annotations

    @RawJSType() @native()

20.  trait ClientCertificate extends Object

    Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

    Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

    Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.

    Annotations

    @RawJSType() @native()

    See also

    Client-Side Certificate

21.  trait ClientCertificates extends Object

    Represents a collection of ClientCertificate resources.

    Represents a collection of ClientCertificate resources.

    Annotations

    @RawJSType() @native()

    See also

    Client-Side Certificate

22.  type ConnectionType = String
23.  type ContentHandlingStrategy = String
24.  trait CreateApiKeyRequest extends Object

    Request to create an ApiKey resource.

    Request to create an ApiKey resource.

    Annotations

    @RawJSType() @native()

25.  trait CreateAuthorizerRequest extends Object

    Request to add a new Authorizer to an existing RestApi resource.

    Request to add a new Authorizer to an existing RestApi resource.

    Annotations

    @RawJSType() @native()

26.  trait CreateBasePathMappingRequest extends Object

    Requests API Gateway to create a new BasePathMapping resource.

    Requests API Gateway to create a new BasePathMapping resource.

    Annotations

    @RawJSType() @native()

27.  trait CreateDeploymentRequest extends Object

    Requests API Gateway to create a Deployment resource.

    Requests API Gateway to create a Deployment resource.

    Annotations

    @RawJSType() @native()

28.  trait CreateDocumentationPartRequest extends Object

    Creates a new documentation part of a given API.

    Creates a new documentation part of a given API.

    Annotations

    @RawJSType() @native()

29.  trait CreateDocumentationVersionRequest extends Object

    Creates a new documentation version of a given API.

    Creates a new documentation version of a given API.

    Annotations

    @RawJSType() @native()

30.  trait CreateDomainNameRequest extends Object

    A request to create a new domain name.

    A request to create a new domain name.

    Annotations

    @RawJSType() @native()

31.  trait CreateModelRequest extends Object

    Request to add a new Model to an existing RestApi resource.

    Request to add a new Model to an existing RestApi resource.

    Annotations

    @RawJSType() @native()

32.  trait CreateRequestValidatorRequest extends Object

    Creates a RequestValidator of a given RestApi.

    Creates a RequestValidator of a given RestApi.

    Annotations

    @RawJSType() @native()

33.  trait CreateResourceRequest extends Object

    Requests API Gateway to create a Resource resource.

    Requests API Gateway to create a Resource resource.

    Annotations

    @RawJSType() @native()

34.  trait CreateRestApiRequest extends Object

    The POST Request to add a new RestApi resource to your collection.

    The POST Request to add a new RestApi resource to your collection.

    Annotations

    @RawJSType() @native()

35.  trait CreateStageRequest extends Object

    Requests API Gateway to create a Stage resource.

    Requests API Gateway to create a Stage resource.

    Annotations

    @RawJSType() @native()

36.  trait CreateUsagePlanKeyRequest extends Object

    The POST request to create a usage plan key for adding an existing API key to a usage plan.

    The POST request to create a usage plan key for adding an existing API key to a usage plan.

    Annotations

    @RawJSType() @native()

37.  trait CreateUsagePlanRequest extends Object

    The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

    The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

    Annotations

    @RawJSType() @native()

38.  trait CreateVpcLinkRequest extends Object

    Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational.

    Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

    Annotations

    @RawJSType() @native()

39.  trait DeleteApiKeyRequest extends Object

    A request to delete the ApiKey resource.

    A request to delete the ApiKey resource.

    Annotations

    @RawJSType() @native()

40.  trait DeleteAuthorizerRequest extends Object

    Request to delete an existing Authorizer resource.

    Request to delete an existing Authorizer resource.

    Annotations

    @RawJSType() @native()

41.  trait DeleteBasePathMappingRequest extends Object

    A request to delete the BasePathMapping resource.

    A request to delete the BasePathMapping resource.

    Annotations

    @RawJSType() @native()

42.  trait DeleteClientCertificateRequest extends Object

    A request to delete the ClientCertificate resource.

    A request to delete the ClientCertificate resource.

    Annotations

    @RawJSType() @native()

43.  trait DeleteDeploymentRequest extends Object

    Requests API Gateway to delete a Deployment resource.

    Requests API Gateway to delete a Deployment resource.

    Annotations

    @RawJSType() @native()

44.  trait DeleteDocumentationPartRequest extends Object

    Deletes an existing documentation part of an API.

    Deletes an existing documentation part of an API.

    Annotations

    @RawJSType() @native()

45.  trait DeleteDocumentationVersionRequest extends Object

    Deletes an existing documentation version of an API.

    Deletes an existing documentation version of an API.

    Annotations

    @RawJSType() @native()

46.  trait DeleteDomainNameRequest extends Object

    A request to delete the DomainName resource.

    A request to delete the DomainName resource.

    Annotations

    @RawJSType() @native()

47.  trait DeleteGatewayResponseRequest extends Object

    Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

    Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

    Annotations

    @RawJSType() @native()

48.  trait DeleteIntegrationRequest extends Object

    Represents a delete integration request.

    Represents a delete integration request.

    Annotations

    @RawJSType() @native()

49.  trait DeleteIntegrationResponseRequest extends Object

    Represents a delete integration response request.

    Represents a delete integration response request.

    Annotations

    @RawJSType() @native()

50.  trait DeleteMethodRequest extends Object

    Request to delete an existing Method resource.

    Request to delete an existing Method resource.

    Annotations

    @RawJSType() @native()

51.  trait DeleteMethodResponseRequest extends Object

    A request to delete an existing MethodResponse resource.

    A request to delete an existing MethodResponse resource.

    Annotations

    @RawJSType() @native()

52.  trait DeleteModelRequest extends Object

    Request to delete an existing model in an existing RestApi resource.

    Request to delete an existing model in an existing RestApi resource.

    Annotations

    @RawJSType() @native()

53.  trait DeleteRequestValidatorRequest extends Object

    Deletes a specified RequestValidator of a given RestApi.

    Deletes a specified RequestValidator of a given RestApi.

    Annotations

    @RawJSType() @native()

54.  trait DeleteResourceRequest extends Object

    Request to delete a Resource.

    Request to delete a Resource.

    Annotations

    @RawJSType() @native()

55.  trait DeleteRestApiRequest extends Object

    Request to delete the specified API from your collection.

    Request to delete the specified API from your collection.

    Annotations

    @RawJSType() @native()

56.  trait DeleteStageRequest extends Object

    Requests API Gateway to delete a Stage resource.

    Requests API Gateway to delete a Stage resource.

    Annotations

    @RawJSType() @native()

57.  trait DeleteUsagePlanKeyRequest extends Object

    The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.

    The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.

    Annotations

    @RawJSType() @native()

58.  trait DeleteUsagePlanRequest extends Object

    The DELETE request to delete a usage plan of a given plan Id.

    The DELETE request to delete a usage plan of a given plan Id.

    Annotations

    @RawJSType() @native()

59.  trait DeleteVpcLinkRequest extends Object

    Deletes an existing VpcLink of a specified identifier.

    Deletes an existing VpcLink of a specified identifier.

    Annotations

    @RawJSType() @native()

60.  trait Deployment extends Object

    An immutable representation of a RestApi resource that can be called by users using Stages.

    An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

    To create a deployment, call POST on the Deployments resource of a RestApi. To view, update, or delete a deployment, call GET, PATCH, or DELETE on the specified deployment resource (/restapis/{restapi_id}/deployments/{deployment_id}).

    Annotations

    @RawJSType() @native()

    See also

    RestApi, Deployments, Stage, CLI, SDKs

61.  trait DeploymentCanarySettings extends Object

    The input configuration for a canary deployment.

    The input configuration for a canary deployment.

    Annotations

    @RawJSType() @native()

62.  trait Deployments extends Object

    Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection.

    Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.

    To create a new deployment of a RestApi, make a POST request against this resource. To view, update, or delete an existing deployment, make a GET, PATCH, or DELETE request, respectively, on a specified Deployment resource.

    Annotations

    @RawJSType() @native()

    See also

    an API, CLI, SDKs

63.  trait DocumentationPart extends Object

    A documentation part for a targeted API entity.

    A documentation part for a targeted API entity.

    A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required. The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.

    Annotations

    @RawJSType() @native()

    See also

    an API, DocumentationParts

64.  trait DocumentationPartIds extends Object

    A collection of the imported DocumentationPart identifiers.

    A collection of the imported DocumentationPart identifiers.

    This is used to return the result when documentation parts in an external (e.g., OpenAPI) file are imported into API Gateway

    Annotations

    @RawJSType() @native()

    See also

    an API, https://docs.aws.amazon.com/apigateway/api-reference/link-relation/documentationpart-import/|documentationpart:import, DocumentationPart

65.  trait DocumentationPartLocation extends Object

    Specifies the target API entity to which the documentation applies.

    Specifies the target API entity to which the documentation applies.

    Annotations

    @RawJSType() @native()

66.  type DocumentationPartLocationStatusCode = String
67.  type DocumentationPartType = String
68.  trait DocumentationParts extends Object

    The collection of documentation parts of an API.

    The collection of documentation parts of an API.

    Annotations

    @RawJSType() @native()

    See also

    an API, DocumentationPart

69.  trait DocumentationVersion extends Object

    A snapshot of the documentation of an API.

    A snapshot of the documentation of an API.

    Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., OpenAPI) file.

    Annotations

    @RawJSType() @native()

    See also

    an API, DocumentationPart, DocumentationVersions

70.  trait DocumentationVersions extends Object

    The collection of documentation snapshots of an API.

    The collection of documentation snapshots of an API.

    Use the DocumentationVersions to manage documentation snapshots associated with various API stages.

    Annotations

    @RawJSType() @native()

    See also

    an API, DocumentationPart, DocumentationVersion

71.  trait DomainName extends Object

    Represents a custom domain name as a user-friendly host name of an API (RestApi).

    Represents a custom domain name as a user-friendly host name of an API (RestApi).

    When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.

    Annotations

    @RawJSType() @native()

    See also

    a Custom Host Name for an API

72.  trait DomainNames extends Object

    Represents a collection of DomainName resources.

    Represents a collection of DomainName resources.

    Annotations

    @RawJSType() @native()

    See also

    Client-Side Certificate

73.  trait EndpointConfiguration extends Object

    The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

    The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

    Annotations

    @RawJSType() @native()

74.  type EndpointType = String
75.  trait ExportResponse extends Object

    The binary blob response to GetExport, which contains the generated SDK.

    The binary blob response to GetExport, which contains the generated SDK.

    Annotations

    @RawJSType() @native()

76.  trait FlushStageAuthorizersCacheRequest extends Object

    Request to flush authorizer cache entries on a specified stage.

    Request to flush authorizer cache entries on a specified stage.

    Annotations

    @RawJSType() @native()

77.  trait FlushStageCacheRequest extends Object

    Requests API Gateway to flush a stage's cache.

    Requests API Gateway to flush a stage's cache.

    Annotations

    @RawJSType() @native()

78.  trait GatewayResponse extends Object

    A gateway response of a given response type and status code, with optional response parameters and mapping templates.

    A gateway response of a given response type and status code, with optional response parameters and mapping templates.

    For more information about valid gateway response types, see Response Types Supported by API Gateway

    Example: Get a Gateway Response of a given response type

    Request

    This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.

    GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45

    The response type is specified as a URL path.

    Response

    The successful operation returns the 200 OK status code and a payload similar to the following:

    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{n "message": context.error.messageString,n "type": "context.error.responseType",n "stage": "context.stage",n "resourcePath": "context.resourcePath",n "stageVariables.a": "stageVariables.a",n "statusCode": "'404'"n}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404"

    }

    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{n "message": context.error.messageString,n "type": "context.error.responseType",n "stage": "context.stage",n "resourcePath": "context.resourcePath",n "stageVariables.a": "stageVariables.a",n "statusCode": "'404'"n}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404" }}}

    GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45 }}}

    Response

    The successful operation returns the 200 OK status code and a payload similar to the following:

    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{n "message": context.error.messageString,n "type": "context.error.responseType",n "stage": "context.stage",n "resourcePath": "context.resourcePath",n "stageVariables.a": "stageVariables.a",n "statusCode": "'404'"n}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404"

    }

    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{n "message": context.error.messageString,n "type": "context.error.responseType",n "stage": "context.stage",n "resourcePath": "context.resourcePath",n "stageVariables.a": "stageVariables.a",n "statusCode": "'404'"n}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404" }}}

    Annotations

    @RawJSType() @native()

    See also

    Gateway Responses

79.  type GatewayResponseType = String
80.  trait GatewayResponses extends Object

    The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs.

    The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.

    For more information about valid gateway response types, see Response Types Supported by API Gateway

    Example: Get the collection of gateway responses of an API

    Request

    This example request shows how to retrieve the GatewayResponses collection from an API.

    GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515

    Response

    The successful operation returns the 200 OK status code and a payload similar to the following:

    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "first": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "gatewayresponse:by-type": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "item": [ { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" }, { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" }, { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } ] }, "_embedded": { "item": [ { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "INTEGRATION_FAILURE", "statusCode": "504" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "RESOURCE_NOT_FOUND", "statusCode": "404" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "REQUEST_TOO_LARGE", "statusCode": "413" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "THROTTLED", "statusCode": "429" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "UNSUPPORTED_MEDIA_TYPE", "statusCode": "415" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "AUTHORIZER_CONFIGURATION_ERROR", "statusCode": "500" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "DEFAULT_5XX" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "DEFAULT_4XX" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "BAD_REQUEST_PARAMETERS", "statusCode": "400" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "BAD_REQUEST_BODY", "statusCode": "400" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "EXPIRED_TOKEN", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "ACCESS_DENIED", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "INVALID_API_KEY", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "UNAUTHORIZED", "statusCode": "401" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "API_CONFIGURATION_ERROR", "statusCode": "500" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "QUOTA_EXCEEDED", "statusCode": "429" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "INTEGRATION_TIMEOUT", "statusCode": "504" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "INVALID_SIGNATURE", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "AUTHORIZER_FAILURE", "statusCode": "500" } ] }

    }

    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "first": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "gatewayresponse:by-type": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "item": [ { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" }, { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" }, { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } ] }, "_embedded": { "item": [ { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "INTEGRATION_FAILURE", "statusCode": "504" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "RESOURCE_NOT_FOUND", "statusCode": "404" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "REQUEST_TOO_LARGE", "statusCode": "413" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "THROTTLED", "statusCode": "429" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "UNSUPPORTED_MEDIA_TYPE", "statusCode": "415" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "AUTHORIZER_CONFIGURATION_ERROR", "statusCode": "500" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "DEFAULT_5XX" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "DEFAULT_4XX" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "BAD_REQUEST_PARAMETERS", "statusCode": "400" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "BAD_REQUEST_BODY", "statusCode": "400" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "EXPIRED_TOKEN", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "ACCESS_DENIED", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "INVALID_API_KEY", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "UNAUTHORIZED", "statusCode": "401" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "API_CONFIGURATION_ERROR", "statusCode": "500" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "QUOTA_EXCEEDED", "statusCode": "429" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "INTEGRATION_TIMEOUT", "statusCode": "504" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "INVALID_SIGNATURE", "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":context.error.messageString}" }, "responseType": "AUTHORIZER_FAILURE", "statusCode": "500" } ] } }}}

    Annotations

    @RawJSType() @native()

    See also

    Gateway Responses

81.  trait GenerateClientCertificateRequest extends Object

    A request to generate a ClientCertificate resource.

    A request to generate a ClientCertificate resource.

    Annotations

    @RawJSType() @native()

82.  trait GetAccountRequest extends Object

    Requests API Gateway to get information about the current Account resource.

    Requests API Gateway to get information about the current Account resource.

    Annotations

    @RawJSType() @native()

83.  trait GetApiKeyRequest extends Object

    A request to get information about the current ApiKey resource.

    A request to get information about the current ApiKey resource.

    Annotations

    @RawJSType() @native()

84.  trait GetApiKeysRequest extends Object

    A request to get information about the current ApiKeys resource.

    A request to get information about the current ApiKeys resource.

    Annotations

    @RawJSType() @native()

85.  trait GetAuthorizerRequest extends Object

    Request to describe an existing Authorizer resource.

    Request to describe an existing Authorizer resource.

    Annotations

    @RawJSType() @native()

86.  trait GetAuthorizersRequest extends Object

    Request to describe an existing Authorizers resource.

    Request to describe an existing Authorizers resource.

    Annotations

    @RawJSType() @native()

87.  trait GetBasePathMappingRequest extends Object

    Request to describe a BasePathMapping resource.

    Request to describe a BasePathMapping resource.

    Annotations

    @RawJSType() @native()

88.  trait GetBasePathMappingsRequest extends Object

    A request to get information about a collection of BasePathMapping resources.

    A request to get information about a collection of BasePathMapping resources.

    Annotations

    @RawJSType() @native()

89.  trait GetClientCertificateRequest extends Object

    A request to get information about the current ClientCertificate resource.

    A request to get information about the current ClientCertificate resource.

    Annotations

    @RawJSType() @native()

90.  trait GetClientCertificatesRequest extends Object

    A request to get information about a collection of ClientCertificate resources.

    A request to get information about a collection of ClientCertificate resources.

    Annotations

    @RawJSType() @native()

91.  trait GetDeploymentRequest extends Object

    Requests API Gateway to get information about a Deployment resource.

    Requests API Gateway to get information about a Deployment resource.

    Annotations

    @RawJSType() @native()

92.  trait GetDeploymentsRequest extends Object

    Requests API Gateway to get information about a Deployments collection.

    Requests API Gateway to get information about a Deployments collection.

    Annotations

    @RawJSType() @native()

93.  trait GetDocumentationPartRequest extends Object

    Gets a specified documentation part of a given API.

    Gets a specified documentation part of a given API.

    Annotations

    @RawJSType() @native()

94.  trait GetDocumentationPartsRequest extends Object

    Gets the documentation parts of an API.

    Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

    Annotations

    @RawJSType() @native()

95.  trait GetDocumentationVersionRequest extends Object

    Gets a documentation snapshot of an API.

    Gets a documentation snapshot of an API.

    Annotations

    @RawJSType() @native()

96.  trait GetDocumentationVersionsRequest extends Object

    Gets the documentation versions of an API.

    Gets the documentation versions of an API.

    Annotations

    @RawJSType() @native()

97.  trait GetDomainNameRequest extends Object

    Request to get the name of a DomainName resource.

    Request to get the name of a DomainName resource.

    Annotations

    @RawJSType() @native()

98.  trait GetDomainNamesRequest extends Object

    Request to describe a collection of DomainName resources.

    Request to describe a collection of DomainName resources.

    Annotations

    @RawJSType() @native()

99.  trait GetExportRequest extends Object

    Request a new export of a RestApi for a particular Stage.

    Request a new export of a RestApi for a particular Stage.

    Annotations

    @RawJSType() @native()

100.  trait GetGatewayResponseRequest extends Object

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

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

     Annotations

     @RawJSType() @native()

101.  trait GetGatewayResponsesRequest extends Object

     Gets the GatewayResponses collection on the given RestApi.

     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.

     Annotations

     @RawJSType() @native()

102.  trait GetIntegrationRequest extends Object

     Represents a request to get the integration configuration.

     Represents a request to get the integration configuration.

     Annotations

     @RawJSType() @native()

103.  trait GetIntegrationResponseRequest extends Object

     Represents a get integration response request.

     Represents a get integration response request.

     Annotations

     @RawJSType() @native()

104.  trait GetMethodRequest extends Object

     Request to describe an existing Method resource.

     Request to describe an existing Method resource.

     Annotations

     @RawJSType() @native()

105.  trait GetMethodResponseRequest extends Object

     Request to describe a MethodResponse resource.

     Request to describe a MethodResponse resource.

     Annotations

     @RawJSType() @native()

106.  trait GetModelRequest extends Object

     Request to list information about a model in an existing RestApi resource.

     Request to list information about a model in an existing RestApi resource.

     Annotations

     @RawJSType() @native()

107.  trait GetModelTemplateRequest extends Object

     Request to generate a sample mapping template used to transform the payload.

     Request to generate a sample mapping template used to transform the payload.

     Annotations

     @RawJSType() @native()

108.  trait GetModelsRequest extends Object

     Request to list existing Models defined for a RestApi resource.

     Request to list existing Models defined for a RestApi resource.

     Annotations

     @RawJSType() @native()

109.  trait GetRequestValidatorRequest extends Object

     Gets a RequestValidator of a given RestApi.

     Gets a RequestValidator of a given RestApi.

     Annotations

     @RawJSType() @native()

110.  trait GetRequestValidatorsRequest extends Object

     Gets the RequestValidators collection of a given RestApi.

     Gets the RequestValidators collection of a given RestApi.

     Annotations

     @RawJSType() @native()

111.  trait GetResourceRequest extends Object

     Request to list information about a resource.

     Request to list information about a resource.

     Annotations

     @RawJSType() @native()

112.  trait GetResourcesRequest extends Object

     Request to list information about a collection of resources.

     Request to list information about a collection of resources.

     Annotations

     @RawJSType() @native()

113.  trait GetRestApiRequest extends Object

     The GET request to list an existing RestApi defined for your collection.

     The GET request to list an existing RestApi defined for your collection.

     Annotations

     @RawJSType() @native()

114.  trait GetRestApisRequest extends Object

     The GET request to list existing RestApis defined for your collection.

     The GET request to list existing RestApis defined for your collection.

     Annotations

     @RawJSType() @native()

115.  trait GetSdkRequest extends Object

     Request a new generated client SDK for a RestApi and Stage.

     Request a new generated client SDK for a RestApi and Stage.

     Annotations

     @RawJSType() @native()

116.  trait GetSdkTypeRequest extends Object

     Get an SdkType instance.

     Get an SdkType instance.

     Annotations

     @RawJSType() @native()

117.  trait GetSdkTypesRequest extends Object

     Get the SdkTypes collection.

     Get the SdkTypes collection.

     Annotations

     @RawJSType() @native()

118.  trait GetStageRequest extends Object

     Requests API Gateway to get information about a Stage resource.

     Requests API Gateway to get information about a Stage resource.

     Annotations

     @RawJSType() @native()

119.  trait GetStagesRequest extends Object

     Requests API Gateway to get information about one or more Stage resources.

     Requests API Gateway to get information about one or more Stage resources.

     Annotations

     @RawJSType() @native()

120.  trait GetTagsRequest extends Object

     Gets the Tags collection for a given resource.

     Gets the Tags collection for a given resource.

     Annotations

     @RawJSType() @native()

121.  trait GetUsagePlanKeyRequest extends Object

     The GET request to get a usage plan key of a given key identifier.

     The GET request to get a usage plan key of a given key identifier.

     Annotations

     @RawJSType() @native()

122.  trait GetUsagePlanKeysRequest extends Object

     The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

     The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

     Annotations

     @RawJSType() @native()

123.  trait GetUsagePlanRequest extends Object

     The GET request to get a usage plan of a given plan identifier.

     The GET request to get a usage plan of a given plan identifier.

     Annotations

     @RawJSType() @native()

124.  trait GetUsagePlansRequest extends Object

     The GET request to get all the usage plans of the caller's account.

     The GET request to get all the usage plans of the caller's account.

     Annotations

     @RawJSType() @native()

125.  trait GetUsageRequest extends Object

     The GET request to get the usage data of a usage plan in a specified time interval.

     The GET request to get the usage data of a usage plan in a specified time interval.

     Annotations

     @RawJSType() @native()

126.  trait GetVpcLinkRequest extends Object

     Gets a specified VPC link under the caller's account in a region.

     Gets a specified VPC link under the caller's account in a region.

     Annotations

     @RawJSType() @native()

127.  trait GetVpcLinksRequest extends Object

     Gets the VpcLinks collection under the caller's account in a selected region.

     Gets the VpcLinks collection under the caller's account in a selected region.

     Annotations

     @RawJSType() @native()

128.  trait ImportApiKeysRequest extends Object

     The POST request to import API keys from an external source, such as a CSV-formatted file.

     The POST request to import API keys from an external source, such as a CSV-formatted file.

     Annotations

     @RawJSType() @native()

129.  trait ImportDocumentationPartsRequest extends Object

     Import documentation parts from an external (e.g., OpenAPI) definition file.

     Import documentation parts from an external (e.g., OpenAPI) definition file.

     Annotations

     @RawJSType() @native()

130.  trait ImportRestApiRequest extends Object

     A POST request to import an API to API Gateway using an input of an API definition file.

     A POST request to import an API to API Gateway using an input of an API definition file.

     Annotations

     @RawJSType() @native()

131.  trait Integration extends Object

     Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

     Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

     In the API Gateway console, the built-in Lambda integration is an AWS integration.

     Annotations

     @RawJSType() @native()

     See also

     an API

132.  trait IntegrationResponse extends Object

     Represents an integration response.

     Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

     Annotations

     @RawJSType() @native()

     See also

     an API

133.  type IntegrationType = String
134.  type ListOfARNs = Array[ProviderARN]
135.  type ListOfApiKey = Array[ApiKey]
136.  type ListOfApiStage = Array[ApiStage]
137.  type ListOfAuthorizer = Array[Authorizer]
138.  type ListOfBasePathMapping = Array[BasePathMapping]
139.  type ListOfClientCertificate = Array[ClientCertificate]
140.  type ListOfDeployment = Array[Deployment]
141.  type ListOfDocumentationPart = Array[DocumentationPart]
142.  type ListOfDocumentationVersion = Array[DocumentationVersion]
143.  type ListOfDomainName = Array[DomainName]
144.  type ListOfEndpointType = Array[EndpointType]
145.  type ListOfGatewayResponse = Array[GatewayResponse]
146.  type ListOfLong = Array[Double]
147.  type ListOfModel = Array[Model]
148.  type ListOfPatchOperation = Array[PatchOperation]
149.  type ListOfRequestValidator = Array[RequestValidator]
150.  type ListOfResource = Array[Resource]
151.  type ListOfRestApi = Array[RestApi]
152.  type ListOfSdkConfigurationProperty = Array[SdkConfigurationProperty]
153.  type ListOfSdkType = Array[SdkType]
154.  type ListOfStage = Array[Stage]
155.  type ListOfStageKeys = Array[StageKey]
156.  type ListOfString = Array[String]
157.  type ListOfUsage = Array[ListOfLong]
158.  type ListOfUsagePlan = Array[UsagePlan]
159.  type ListOfUsagePlanKey = Array[UsagePlanKey]
160.  type ListOfVpcLink = Array[VpcLink]
161.  type LocationStatusType = String
162.  type MapOfApiStageThrottleSettings = Dictionary[ThrottleSettings]
163.  type MapOfIntegrationResponse = Dictionary[IntegrationResponse]
164.  type MapOfKeyUsages = Dictionary[ListOfUsage]
165.  type MapOfMethod = Dictionary[Method]
166.  type MapOfMethodResponse = Dictionary[MethodResponse]
167.  type MapOfMethodSettings = Dictionary[MethodSetting]
168.  type MapOfMethodSnapshot = Dictionary[MethodSnapshot]
169.  type MapOfStringToBoolean = Dictionary[NullableBoolean]
170.  type MapOfStringToList = Dictionary[ListOfString]
171.  type MapOfStringToString = Dictionary[String]
172.  trait Method extends Object

     Represents a client-facing interface by which the client calls the API to access back-end resources.

     Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.

     Example: Retrive the GET method on a specified resource

     Request

     The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri).

     GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash

     }

     Response

     The successful response returns a 200 OK status code and a payload similar to the following:

     { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": true, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "util.urlDecode("%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E")" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } }

     } In the example above, the response template for the 200 OK response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E and the output is decoded using the https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#util-templat-reference|util.urlDecode() helper function.

     { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": true, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "util.urlDecode("%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E")" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }}}

     GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash }}}

     Response

     The successful response returns a 200 OK status code and a payload similar to the following:

     { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": true, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "util.urlDecode("%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E")" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } }

     } In the example above, the response template for the 200 OK response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E and the output is decoded using the https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#util-templat-reference|util.urlDecode() helper function.

     { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": true, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "util.urlDecode("%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E")" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }}}

     Annotations

     @RawJSType() @native()

     See also

     MethodResponse, Integration, IntegrationResponse, Resource, up an API's method

173.  trait MethodResponse extends Object

     Represents a method response of a given HTTP status code returned to the client.

     Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

     Example: A MethodResponse instance of an API

     Request

     The example request retrieves a MethodResponse of the 200 status code.

     GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash

     }

     Response

     The successful response returns 200 OK status and a payload as follows:

     { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200"

     }

     { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" }}}

     GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash }}}

     Response

     The successful response returns 200 OK status and a payload as follows:

     { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200"

     }

     { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" }}}

     Annotations

     @RawJSType() @native()

     See also

     Method, IntegrationResponse, Integration an API

174.  trait MethodSetting extends Object

     Specifies the method setting properties.

     Specifies the method setting properties.

     Annotations

     @RawJSType() @native()

175.  trait MethodSnapshot extends Object

     Represents a summary of a Method resource, given a particular date and time.

     Represents a summary of a Method resource, given a particular date and time.

     Annotations

     @RawJSType() @native()

176.  trait Model extends Object

     Represents the data structure of a method's request or response payload.

     Represents the data structure of a method's request or response payload.

     A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end. A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

     Annotations

     @RawJSType() @native()

     See also

     Method, MethodResponse, and Mappings

177.  trait Models extends Object

     Represents a collection of Model resources.

     Represents a collection of Model resources.

     Annotations

     @RawJSType() @native()

     See also

     Method, MethodResponse, and Mappings

178.  type NullableBoolean = Boolean
179.  type NullableInteger = Int
180.  type Op = String
181.  trait PatchOperation extends Object

     A single patch operation to apply to the specified resource.

     A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.

     Annotations

     @RawJSType() @native()

182.  type PathToMapOfMethodSnapshot = Dictionary[MapOfMethodSnapshot]
183.  type ProviderARN = String
184.  trait PutGatewayResponseRequest extends Object

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

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

     Annotations

     @RawJSType() @native()

185.  trait PutIntegrationRequest extends Object

     Sets up a method's integration.

     Sets up a method's integration.

     Annotations

     @RawJSType() @native()

186.  trait PutIntegrationResponseRequest extends Object

     Represents a put integration response request.

     Represents a put integration response request.

     Annotations

     @RawJSType() @native()

187.  trait PutMethodRequest extends Object

     Request to add a method to an existing Resource resource.

     Request to add a method to an existing Resource resource.

     Annotations

     @RawJSType() @native()

188.  trait PutMethodResponseRequest extends Object

     Request to add a MethodResponse to an existing Method resource.

     Request to add a MethodResponse to an existing Method resource.

     Annotations

     @RawJSType() @native()

189.  type PutMode = String
190.  trait PutRestApiRequest extends Object

     A PUT request to update an existing API, with external API definitions specified as the request body.

     A PUT request to update an existing API, with external API definitions specified as the request body.

     Annotations

     @RawJSType() @native()

191.  type QuotaPeriodType = String
192.  trait QuotaSettings extends Object

     Quotas configured for a usage plan.

     Quotas configured for a usage plan.

     Annotations

     @RawJSType() @native()

193.  trait RequestValidator extends Object

     A set of validation rules for incoming Method requests.

     A set of validation rules for incoming Method requests.

     In OpenAPI, a RequestValidator of an API is defined by the https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html|x-amazon-apigateway-request-validators.requestValidator object. It the referenced using the https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator|x-amazon-apigateway-request-validator property.

     Annotations

     @RawJSType() @native()

     See also

     Basic Request Validation in API Gateway

194.  trait RequestValidators extends Object

     A collection of RequestValidator resources of a given RestApi.

     A collection of RequestValidator resources of a given RestApi.

     In OpenAPI, the RequestValidators of an API is defined by the https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.html|x-amazon-apigateway-request-validators extension.

     Annotations

     @RawJSType() @native()

     See also

     Basic Request Validation in API Gateway

195.  trait Resource extends Object

     Represents an API resource.

     Represents an API resource.

     Annotations

     @RawJSType() @native()

     See also

     an API

196.  trait Resources extends Object

     Represents a collection of Resource resources.

     Represents a collection of Resource resources.

     Annotations

     @RawJSType() @native()

     See also

     an API

197.  trait RestApi extends Object

     Represents a REST API.

     Represents a REST API.

     Annotations

     @RawJSType() @native()

     See also

     an API

198.  trait RestApis extends Object

     Contains references to your APIs and links that guide you in how to interact with your collection.

     Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.

     Annotations

     @RawJSType() @native()

     See also

     an API

199.  trait SdkConfigurationProperty extends Object

     A configuration property of an SDK type.

     A configuration property of an SDK type.

     Annotations

     @RawJSType() @native()

200.  trait SdkResponse extends Object

     The binary blob response to GetSdk, which contains the generated SDK.

     The binary blob response to GetSdk, which contains the generated SDK.

     Annotations

     @RawJSType() @native()

201.  trait SdkType extends Object

     A type of SDK that API Gateway can generate.

     A type of SDK that API Gateway can generate.

     Annotations

     @RawJSType() @native()

202.  trait SdkTypes extends Object

     The collection of SdkType instances.

     The collection of SdkType instances.

     Annotations

     @RawJSType() @native()

203.  trait Stage extends Object

     Represents a unique identifier for a version of a deployed RestApi that is callable by users.

     Represents a unique identifier for a version of a deployed RestApi that is callable by users.

     Annotations

     @RawJSType() @native()

     See also

     an API

204.  trait StageKey extends Object

     A reference to a unique stage identified in the format {restApiId}/{stage}.

     A reference to a unique stage identified in the format {restApiId}/{stage}.

     Annotations

     @RawJSType() @native()

205.  trait Stages extends Object

     A list of Stage resources that are associated with the ApiKey resource.

     A list of Stage resources that are associated with the ApiKey resource.

     Annotations

     @RawJSType() @native()

     See also

     API in Stages

206.  type StatusCode = String
207.  trait TagResourceRequest extends Object

     Adds or updates a tag on a given resource.

     Adds or updates a tag on a given resource.

     Annotations

     @RawJSType() @native()

208.  trait Tags extends Object

     The collection of tags.

     The collection of tags. Each tag element is associated with a given resource.

     Annotations

     @RawJSType() @native()

209.  trait Template extends Object

     Represents a mapping template used to transform a payload.

     Represents a mapping template used to transform a payload.

     Annotations

     @RawJSType() @native()

     See also

     Templates

210.  trait TestInvokeAuthorizerRequest extends Object

     Make a request to simulate the execution of an Authorizer.

     Make a request to simulate the execution of an Authorizer.

     Annotations

     @RawJSType() @native()

211.  trait TestInvokeAuthorizerResponse extends Object

     Represents the response of the test invoke request for a custom Authorizer

     Represents the response of the test invoke request for a custom Authorizer

     Annotations

     @RawJSType() @native()

212.  trait TestInvokeMethodRequest extends Object

     Make a request to simulate the execution of a Method.

     Make a request to simulate the execution of a Method.

     Annotations

     @RawJSType() @native()

213.  trait TestInvokeMethodResponse extends Object

     Represents the response of the test invoke request in the HTTP method.

     Represents the response of the test invoke request in the HTTP method.

     Annotations

     @RawJSType() @native()

     See also

     API using the API Gateway console

214.  trait ThrottleSettings extends Object

     The API request rate limits.

     The API request rate limits.

     Annotations

     @RawJSType() @native()

215.  type Timestamp = Date
216.  type UnauthorizedCacheControlHeaderStrategy = String
217.  trait UntagResourceRequest extends Object

     Removes a tag from a given resource.

     Removes a tag from a given resource.

     Annotations

     @RawJSType() @native()

218.  trait UpdateAccountRequest extends Object

     Requests API Gateway to change information about the current Account resource.

     Requests API Gateway to change information about the current Account resource.

     Annotations

     @RawJSType() @native()

219.  trait UpdateApiKeyRequest extends Object

     A request to change information about an ApiKey resource.

     A request to change information about an ApiKey resource.

     Annotations

     @RawJSType() @native()

220.  trait UpdateAuthorizerRequest extends Object

     Request to update an existing Authorizer resource.

     Request to update an existing Authorizer resource.

     Annotations

     @RawJSType() @native()

221.  trait UpdateBasePathMappingRequest extends Object

     A request to change information about the BasePathMapping resource.

     A request to change information about the BasePathMapping resource.

     Annotations

     @RawJSType() @native()

222.  trait UpdateClientCertificateRequest extends Object

     A request to change information about an ClientCertificate resource.

     A request to change information about an ClientCertificate resource.

     Annotations

     @RawJSType() @native()

223.  trait UpdateDeploymentRequest extends Object

     Requests API Gateway to change information about a Deployment resource.

     Requests API Gateway to change information about a Deployment resource.

     Annotations

     @RawJSType() @native()

224.  trait UpdateDocumentationPartRequest extends Object

     Updates an existing documentation part of a given API.

     Updates an existing documentation part of a given API.

     Annotations

     @RawJSType() @native()

225.  trait UpdateDocumentationVersionRequest extends Object

     Updates an existing documentation version of an API.

     Updates an existing documentation version of an API.

     Annotations

     @RawJSType() @native()

226.  trait UpdateDomainNameRequest extends Object

     A request to change information about the DomainName resource.

     A request to change information about the DomainName resource.

     Annotations

     @RawJSType() @native()

227.  trait UpdateGatewayResponseRequest extends Object

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

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

     Annotations

     @RawJSType() @native()

228.  trait UpdateIntegrationRequest extends Object

     Represents an update integration request.

     Represents an update integration request.

     Annotations

     @RawJSType() @native()

229.  trait UpdateIntegrationResponseRequest extends Object

     Represents an update integration response request.

     Represents an update integration response request.

     Annotations

     @RawJSType() @native()

230.  trait UpdateMethodRequest extends Object

     Request to update an existing Method resource.

     Request to update an existing Method resource.

     Annotations

     @RawJSType() @native()

231.  trait UpdateMethodResponseRequest extends Object

     A request to update an existing MethodResponse resource.

     A request to update an existing MethodResponse resource.

     Annotations

     @RawJSType() @native()

232.  trait UpdateModelRequest extends Object

     Request to update an existing model in an existing RestApi resource.

     Request to update an existing model in an existing RestApi resource.

     Annotations

     @RawJSType() @native()

233.  trait UpdateRequestValidatorRequest extends Object

     Updates a RequestValidator of a given RestApi.

     Updates a RequestValidator of a given RestApi.

     Annotations

     @RawJSType() @native()

234.  trait UpdateResourceRequest extends Object

     Request to change information about a Resource resource.

     Request to change information about a Resource resource.

     Annotations

     @RawJSType() @native()

235.  trait UpdateRestApiRequest extends Object

     Request to update an existing RestApi resource in your collection.

     Request to update an existing RestApi resource in your collection.

     Annotations

     @RawJSType() @native()

236.  trait UpdateStageRequest extends Object

     Requests API Gateway to change information about a Stage resource.

     Requests API Gateway to change information about a Stage resource.

     Annotations

     @RawJSType() @native()

237.  trait UpdateUsagePlanRequest extends Object

     The PATCH request to update a usage plan of a given plan Id.

     The PATCH request to update a usage plan of a given plan Id.

     Annotations

     @RawJSType() @native()

238.  trait UpdateUsageRequest extends Object

     The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.

     The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.

     Annotations

     @RawJSType() @native()

239.  trait UpdateVpcLinkRequest extends Object

     Updates an existing VpcLink of a specified identifier.

     Updates an existing VpcLink of a specified identifier.

     Annotations

     @RawJSType() @native()

240.  trait Usage extends Object

     Represents the usage data of a usage plan.

     Represents the usage data of a usage plan.

     Annotations

     @RawJSType() @native()

     See also

     and Use Usage Plans, Usage in a Usage Plan

241.  trait UsagePlan extends Object

     Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

     Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

     In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

     Annotations

     @RawJSType() @native()

     See also

     and Use Usage Plans

242.  trait UsagePlanKey extends Object

     Represents a usage plan key to identify a plan customer.

     Represents a usage plan key to identify a plan customer.

     To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey. "

     Annotations

     @RawJSType() @native()

     See also

     and Use Usage Plans

243.  trait UsagePlanKeys extends Object

     Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.

     Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.

     Annotations

     @RawJSType() @native()

     See also

     and Use Usage Plans

244.  trait UsagePlans extends Object

     Represents a collection of usage plans for an AWS account.

     Represents a collection of usage plans for an AWS account.

     Annotations

     @RawJSType() @native()

     See also

     and Use Usage Plans

245.  trait VpcLink extends Object

     A API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

     A API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

     To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.

     Annotations

     @RawJSType() @native()

246.  type VpcLinkStatus = String
247.  trait VpcLinks extends Object

     The collection of VPC links under the caller's account in a region.

     The collection of VPC links under the caller's account in a region.

     Annotations

     @RawJSType() @native()

     See also

     Started with Private Integrations, up Private Integrations