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

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}).

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.

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.

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.

In OpenAPI, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator object. It the referenced using the x-amazon-apigateway-request-validator property.

The resource methods are a map of methods indexed by methods'' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request

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

Response

{ "_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": false, "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#foreach($stream in $input.path(''$.StreamNames''))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n"
              }, "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"
              } } }

If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

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.

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.

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.

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.

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 API 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.

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.

Documenting an API, DocumentationPart

DocumentationVersions: type: object properties: position: "$ref": "#/components/schemas/String" items: allOf: - "$ref": "#/components/schemas/ListOfDocumentationVersion" - xml: name: item description: The current page of elements from this collection. description:

The collection of documentation snapshots of an API.

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

Documenting an API, DocumentationPart, DocumentationVersion

DomainNames: type: object properties: position: "$ref": "#/components/schemas/String" items: allOf: - "$ref": "#/components/schemas/ListOfDomainName" - xml: name: item description: The current page of elements from this collection. description:

Represents a collection of DomainName resources.

Use Client-Side Certificate

ExportResponse: type: object properties: body: allOf: - "$ref": "#/components/schemas/Blob" - description: The binary blob response to GetExport, which contains the export. description: The binary blob response to GetExport, which contains the generated SDK. GatewayResponse: type: object properties: responseType: allOf: - "$ref": "#/components/schemas/GatewayResponseType" - description: The response type of the associated GatewayResponse. statusCode: allOf: - "$ref": "#/components/schemas/StatusCode" - description: The HTTP status code for this GatewayResponse. responseParameters: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. responseTemplates: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: Response templates of the GatewayResponse as a string-to-string map of key-value pairs. defaultResponse: allOf: - "$ref": "#/components/schemas/Boolean" - description: 'A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer. ' description: '

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 Gateway 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" }

Customize Gateway Responses

' GatewayResponses: type: object properties: position: "$ref": "#/components/schemas/String" items: allOf: - "$ref": "#/components/schemas/ListOfGatewayResponse" - xml: name: item description: Returns the entire collection, because of no pagination support. description: '

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 Gateway 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" } ] } }

Customize Gateway Responses

' Integration: type: object properties: type: allOf: - "$ref": "#/components/schemas/IntegrationType" - description: '

Specifies an API method integration type. The valid value is one of the following:

AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

' httpMethod: allOf: - "$ref": "#/components/schemas/String" - description: Specifies the integration's HTTP method type. uri: allOf: - "$ref": "#/components/schemas/String" - description:

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

connectionType: allOf: - "$ref": "#/components/schemas/ConnectionType" - description: The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET. connectionId: allOf: - "$ref": "#/components/schemas/String" - description: The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise. credentials: allOf: - "$ref": "#/components/schemas/String" - description: Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null. requestParameters: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name. requestTemplates: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. passthroughBehavior: allOf: - "$ref": "#/components/schemas/String" - description: "

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:

WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

" contentHandling: allOf: - "$ref": "#/components/schemas/ContentHandlingStrategy" - description: "

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

" timeoutInMillis: allOf: - "$ref": "#/components/schemas/Integer" - description: Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. cacheNamespace: allOf: - "$ref": "#/components/schemas/String" - description: Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources. cacheKeyParameters: allOf: - "$ref": "#/components/schemas/ListOfString" - description: A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters. integrationResponses: allOf: - "$ref": "#/components/schemas/MapOfIntegrationResponse" - description: '

Specifies the integration''s responses.

Example: Get integration responses of a method

Request

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200
              HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
              X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/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-integration-response-{rel}.html",
              "name": "integrationresponse", "templated": true }, "self": { "href":
              "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/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#foreach($stream in $input.path(''$.StreamNames''))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n"
              }, "statusCode": "200" }

Creating an API

' tlsConfig: allOf: - "$ref": "#/components/schemas/TlsConfig" - description: Specifies the TLS configuration for an integration. description:

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.

Creating an API

IntegrationResponse: type: object properties: statusCode: allOf: - "$ref": "#/components/schemas/StatusCode" - description: Specifies the status code that is used to map the integration response to an existing MethodResponse. selectionPattern: allOf: - "$ref": "#/components/schemas/String" - description: Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched. responseParameters: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix. responseTemplates: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value. contentHandling: allOf: - "$ref": "#/components/schemas/ContentHandlingStrategy" - description: "

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

" description:

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.

Creating an API

Method: type: object properties: httpMethod: allOf: - "$ref": "#/components/schemas/String" - description: The method's HTTP verb. authorizationType: allOf: - "$ref": "#/components/schemas/String" - description: The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool. authorizerId: allOf: - "$ref": "#/components/schemas/String" - description: The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM. apiKeyRequired: allOf: - "$ref": "#/components/schemas/NullableBoolean" - description: A boolean flag specifying whether a valid ApiKey is required to invoke this method. requestValidatorId: allOf: - "$ref": "#/components/schemas/String" - description: The identifier of a RequestValidator for request validation. operationName: allOf: - "$ref": "#/components/schemas/String" - description: A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example. requestParameters: allOf: - "$ref": "#/components/schemas/MapOfStringToBoolean" - description: A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates. requestModels: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key). methodResponses: allOf: - "$ref": "#/components/schemas/MapOfMethodResponse" - description: '

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response''s HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200
              HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
              Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256
              Credential={access_key_ID}/20160613/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-method-response-{rel}.html",
              "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200",
              "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200"
              }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200"
              } }, "responseModels": { "application/json": "Empty" }, "responseParameters":
              { "method.response.header.operator": false, "method.response.header.operand_2":
              false, "method.response.header.operand_1": false }, "statusCode": "200"
              }

AWS CLI

' methodIntegration: allOf: - "$ref": "#/components/schemas/Integration" - description: '

Gets the method''s integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration
              HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
              Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256
              Credential={access_key_ID}/20160613/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 } ], "self": { "href":
              "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete":
              { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration"
              }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200",
              "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration"
              }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}",
              "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch",
              "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod":
              "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates":
              { "application/json": "{\n \"a\": \"$input.params(''operand1'')\",\n
              \"b\": \"$input.params(''operand2'')\", \n \"op\": \"$input.params(''operator'')\"
              \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations",
              "_embedded": { "integration:responses": { "_links": { "self": { "href":
              "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200",
              "name": "200", "title": "200" }, "integrationresponse:delete": { "href":
              "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200"
              }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200"
              } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op",
              "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1":
              "integration.response.body.a" }, "responseTemplates": { "application/json":
              "#set($res = $input.path(''$''))\n{\n \"result\": \"$res.a, $res.b,
              $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\"
              : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode":
              "200" } } }

AWS CLI

' authorizationScopes: allOf: - "$ref": "#/components/schemas/ListOfString" - description: A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes. description: '

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 $util.urlDecode() helper function.

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

' MethodResponse: type: object properties: statusCode: allOf: - "$ref": "#/components/schemas/StatusCode" - description: The method response's status code. responseParameters: allOf: - "$ref": "#/components/schemas/MapOfStringToBoolean" - description: A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.) responseModels: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value. description: '

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" }

Method, IntegrationResponse, Integration Creating an API

' Template: type: object properties: value: allOf: - "$ref": "#/components/schemas/String" - description: The Apache Velocity Template Language (VTL) template content used for the template resource. description:

Represents a mapping template used to transform a payload.

Mapping Templates

Models: type: object properties: position: "$ref": "#/components/schemas/String" items: allOf: - "$ref": "#/components/schemas/ListOfModel" - xml: name: item description: The current page of elements from this collection. description:

Represents a collection of Model resources.

Method, MethodResponse, Models and Mappings

RequestValidators: type: object properties: position: "$ref": "#/components/schemas/String" items: allOf: - "$ref": "#/components/schemas/ListOfRequestValidator" - xml: name: item description: The current page of elements from this collection. description:

A collection of RequestValidator resources of a given RestApi.

In OpenAPI, the RequestValidators of an API is defined by the x-amazon-apigateway-request-validators extension.

Enable Basic Request Validation in API Gateway

Resources: type: object properties: position: "$ref": "#/components/schemas/String" items: allOf: - "$ref": "#/components/schemas/ListOfResource" - xml: name: item description: The current page of elements from this collection. description:

Represents a collection of Resource resources.

Create an API

RestApis: type: object properties: position: "$ref": "#/components/schemas/String" items: allOf: - "$ref": "#/components/schemas/ListOfRestApi" - xml: name: item description: The current page of elements from this collection. description:

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.

Create an API

SdkResponse: type: object properties: body: allOf: - "$ref": "#/components/schemas/Blob" - description: The binary blob response to GetSdk, which contains the generated SDK. description: The binary blob response to GetSdk, which contains the generated SDK. SdkType: type: object properties: id: allOf: - "$ref": "#/components/schemas/String" - description: The identifier of an SdkType instance. friendlyName: allOf: - "$ref": "#/components/schemas/String" - description: The user-friendly name of an SdkType instance. description: allOf: - "$ref": "#/components/schemas/String" - description: The description of an SdkType. configurationProperties: allOf: - "$ref": "#/components/schemas/ListOfSdkConfigurationProperty" - description: A list of configuration properties of an SdkType. description: A type of SDK that API Gateway can generate. SdkTypes: type: object properties: position: "$ref": "#/components/schemas/String" items: allOf: - "$ref": "#/components/schemas/ListOfSdkType" - xml: name: item description: The current page of elements from this collection. description: The collection of SdkType instances. Stages: type: object properties: item: allOf: - "$ref": "#/components/schemas/ListOfStage" - description: The current page of elements from this collection. description:

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

Deploying API in Stages

Tags: type: object properties: tags: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: The collection of tags. Each tag element is associated with a given resource. description: The collection of tags. Each tag element is associated with a given resource. Usage: type: object properties: usagePlanId: allOf: - "$ref": "#/components/schemas/String" - description: The plan Id associated with this usage data. startDate: allOf: - "$ref": "#/components/schemas/String" - description: The starting date of the usage data. endDate: allOf: - "$ref": "#/components/schemas/String" - description: The ending date of the usage data. position: "$ref": "#/components/schemas/String" items: allOf: - "$ref": "#/components/schemas/MapOfKeyUsages" - xml: name: values description: 'The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example,

{..., "values" : { "{api_key}" : [ [0, 100],
              [10, 90], [100, 10]]}

, where {api_key} stands for an API key value and the daily log entry is of the format

[used
              quota, remaining quota]

.' description:

Represents the usage data of a usage plan.

Create and Use Usage Plans, Manage Usage in a Usage Plan

UsagePlanKeys: type: object properties: position: "$ref": "#/components/schemas/String" items: allOf: - "$ref": "#/components/schemas/ListOfUsagePlanKey" - xml: name: item description: The current page of elements from this collection. description:

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

Create and Use Usage Plans

UsagePlans: type: object properties: position: "$ref": "#/components/schemas/String" items: allOf: - "$ref": "#/components/schemas/ListOfUsagePlan" - xml: name: item description: The current page of elements from this collection. description:

Represents a collection of usage plans for an AWS account.

Create and Use Usage Plans

VpcLinks: type: object properties: position: "$ref": "#/components/schemas/String" items: allOf: - "$ref": "#/components/schemas/ListOfVpcLink" - xml: name: item description: The current page of elements from this collection. description:

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

Getting Started with Private Integrations, Set up Private Integrations

ApiKeyIds: type: object properties: ids: allOf: - "$ref": "#/components/schemas/ListOfString" - description: A list of all the ApiKey identifiers. warnings: allOf: - "$ref": "#/components/schemas/ListOfString" - description: A list of warning messages. description: The identifier of an ApiKey used in a UsagePlan. DocumentationPartIds: type: object properties: ids: allOf: - "$ref": "#/components/schemas/ListOfString" - description: A list of the returned documentation part identifiers. warnings: allOf: - "$ref": "#/components/schemas/ListOfString" - description: A list of warning messages reported during import of documentation parts. description:

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

Documenting an API, documentationpart:import, DocumentationPart

NullableBoolean: type: boolean TestInvokeAuthorizerResponse: type: object properties: clientStatus: allOf: - "$ref": "#/components/schemas/Integer" - description: The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded. log: allOf: - "$ref": "#/components/schemas/String" - description: The API Gateway execution log for the test authorizer request. latency: allOf: - "$ref": "#/components/schemas/Long" - description: The execution latency of the test authorizer request. principalId: allOf: - "$ref": "#/components/schemas/String" - description: The principal identity returned by the Authorizer policy: allOf: - "$ref": "#/components/schemas/String" - description: The JSON policy document returned by the Authorizer authorization: "$ref": "#/components/schemas/MapOfStringToList" claims: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API. description: Represents the response of the test invoke request for a custom Authorizer TestInvokeMethodResponse: type: object properties: status: allOf: - "$ref": "#/components/schemas/Integer" - description: The HTTP status code. body: allOf: - "$ref": "#/components/schemas/String" - description: The body of the HTTP response. headers: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: The headers of the HTTP response. multiValueHeaders: allOf: - "$ref": "#/components/schemas/MapOfStringToList" - description: The headers of the HTTP response as a map from string to list of values. log: allOf: - "$ref": "#/components/schemas/String" - description: The API Gateway execution log for the test invoke request. latency: allOf: - "$ref": "#/components/schemas/Long" - description: The execution latency of the test invoke request. description:

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

Test API using the API Gateway console

PatchOperation: type: object properties: op: allOf: - "$ref": "#/components/schemas/Op" - description: " An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message." path: allOf: - "$ref": "#/components/schemas/String" - description: 'The op operation''s target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g.,

{"name": {"child/name":
              "child-value"}}

), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.' value: allOf: - "$ref": "#/components/schemas/String" - description: 'The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., ''{"a": ...}''. In a Windows shell, see Using JSON for Parameters.' from: allOf: - "$ref": "#/components/schemas/String" - description: The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId". description: 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. AccessLogSettings: type: object properties: format: allOf: - "$ref": "#/components/schemas/String" - description: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. destinationArn: allOf: - "$ref": "#/components/schemas/String" - description: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. description: Access log settings, including the access log format and access log destination ARN. ThrottleSettings: type: object properties: burstLimit: allOf: - "$ref": "#/components/schemas/Integer" - description: The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity. rateLimit: allOf: - "$ref": "#/components/schemas/Double" - description: The API request steady-state rate limit. description: " The API request rate limits." Timestamp: type: string format: date-time ApiKeySourceType: type: string enum: - HEADER - AUTHORIZER ListOfApiKey: type: array items: "$ref": "#/components/schemas/ApiKey" ApiKeysFormat: type: string enum: - csv MapOfApiStageThrottleSettings: type: object additionalProperties: "$ref": "#/components/schemas/ThrottleSettings" AuthorizerType: type: string enum: - TOKEN - REQUEST - COGNITO_USER_POOLS description: The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool. ListOfARNs: type: array items: "$ref": "#/components/schemas/ProviderARN" NullableInteger: type: integer ListOfAuthorizer: type: array items: "$ref": "#/components/schemas/Authorizer" ListOfBasePathMapping: type: array items: "$ref": "#/components/schemas/BasePathMapping" Blob: type: string CacheClusterSize: type: string enum: - '0.5' - '1.6' - '6.1' - '13.5' - '28.4' - '58.2' - '118' - '237' description: Returns the size of the CacheCluster. CacheClusterStatus: type: string enum: - CREATE_IN_PROGRESS - AVAILABLE - DELETE_IN_PROGRESS - NOT_AVAILABLE - FLUSH_IN_PROGRESS description: Returns the status of the CacheCluster. CanarySettings: type: object properties: percentTraffic: allOf: - "$ref": "#/components/schemas/Double" - description: The percent (0-100) of traffic diverted to a canary deployment. deploymentId: allOf: - "$ref": "#/components/schemas/String" - description: The ID of the canary deployment. stageVariableOverrides: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. useStageCache: allOf: - "$ref": "#/components/schemas/Boolean" - description: A Boolean flag to indicate whether the canary deployment uses the stage cache or not. description: Configuration settings of a canary deployment. ListOfClientCertificate: type: array items: "$ref": "#/components/schemas/ClientCertificate" ConnectionType: type: string enum: - INTERNET - VPC_LINK ContentHandlingStrategy: type: string enum: - CONVERT_TO_BINARY - CONVERT_TO_TEXT ListOfStageKeys: type: array items: "$ref": "#/components/schemas/StageKey" CreateApiKeyRequest: type: object title: CreateApiKeyRequest properties: name: allOf: - "$ref": "#/components/schemas/String" - description: The name of the ApiKey. description: allOf: - "$ref": "#/components/schemas/String" - description: The description of the ApiKey. enabled: allOf: - "$ref": "#/components/schemas/Boolean" - description: Specifies whether the ApiKey can be used by callers. generateDistinctId: allOf: - "$ref": "#/components/schemas/Boolean" - description: Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used. value: allOf: - "$ref": "#/components/schemas/String" - description: Specifies a value of the API key. stageKeys: allOf: - "$ref": "#/components/schemas/ListOfStageKeys" - description: DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. customerId: allOf: - "$ref": "#/components/schemas/String" - description: An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace. tags: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters. description: Request to create an ApiKey resource. CreateAuthorizerRequest: type: object required: - name - type title: CreateAuthorizerRequest properties: name: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The name of the authorizer." type: allOf: - "$ref": "#/components/schemas/AuthorizerType" - description: "[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool." providerARNs: allOf: - "$ref": "#/components/schemas/ListOfARNs" - description: 'A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.' authType: allOf: - "$ref": "#/components/schemas/String" - description: Optional customer-defined field, used in OpenAPI imports and exports without functional impact. authorizerUri: allOf: - "$ref": "#/components/schemas/String" - description: Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example,

arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations

. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. authorizerCredentials: allOf: - "$ref": "#/components/schemas/String" - description: Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. identitySource: allOf: - "$ref": "#/components/schemas/String" - description: The identity source for which authorization is requested.

For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

identityValidationExpression: allOf: - "$ref": "#/components/schemas/String" - description: A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer. authorizerResultTtlInSeconds: allOf: - "$ref": "#/components/schemas/NullableInteger" - description: The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour. description: Request to add a new Authorizer to an existing RestApi resource. CreateBasePathMappingRequest: type: object required: - restApiId title: CreateBasePathMappingRequest properties: basePath: allOf: - "$ref": "#/components/schemas/String" - description: The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name. restApiId: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The string identifier of the associated RestApi." stage: allOf: - "$ref": "#/components/schemas/String" - description: The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name. description: Requests API Gateway to create a new BasePathMapping resource. DeploymentCanarySettings: type: object properties: percentTraffic: allOf: - "$ref": "#/components/schemas/Double" - description: The percentage (0.0-100.0) of traffic routed to the canary deployment. stageVariableOverrides: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values. useStageCache: allOf: - "$ref": "#/components/schemas/Boolean" - description: A Boolean flag to indicate whether the canary release deployment uses the stage cache or not. description: The input configuration for a canary deployment. CreateDeploymentRequest: type: object title: CreateDeploymentRequest properties: stageName: allOf: - "$ref": "#/components/schemas/String" - description: The name of the Stage resource for the Deployment resource to create. stageDescription: allOf: - "$ref": "#/components/schemas/String" - description: The description of the Stage resource for the Deployment resource to create. description: allOf: - "$ref": "#/components/schemas/String" - description: The description for the Deployment resource to create. cacheClusterEnabled: allOf: - "$ref": "#/components/schemas/NullableBoolean" - description: Enables a cache cluster for the Stage resource specified in the input. cacheClusterSize: allOf: - "$ref": "#/components/schemas/CacheClusterSize" - description: Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled. variables: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. canarySettings: allOf: - "$ref": "#/components/schemas/DeploymentCanarySettings" - description: 'The input configuration for the canary deployment when the deployment is a canary release deployment. ' tracingEnabled: allOf: - "$ref": "#/components/schemas/NullableBoolean" - description: Specifies whether active tracing with X-ray is enabled for the Stage. description: Requests API Gateway to create a Deployment resource. DocumentationPartLocation: type: object required: - type properties: type: allOf: - "$ref": "#/components/schemas/DocumentationPartType" - description: "[Required] The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type." path: allOf: - "$ref": "#/components/schemas/String" - description: The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix. method: allOf: - "$ref": "#/components/schemas/String" - description: The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly. statusCode: allOf: - "$ref": "#/components/schemas/DocumentationPartLocationStatusCode" - description: The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly. name: allOf: - "$ref": "#/components/schemas/String" - description: The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type. description: Specifies the target API entity to which the documentation applies. CreateDocumentationPartRequest: type: object required: - location - properties title: CreateDocumentationPartRequest properties: location: allOf: - "$ref": "#/components/schemas/DocumentationPartLocation" - description: "[Required] The location of the targeted API entity of the to-be-created documentation part." properties: description: "[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published." description: Creates a new documentation part of a given API. CreateDocumentationVersionRequest: type: object required: - documentationVersion title: CreateDocumentationVersionRequest properties: documentationVersion: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The version identifier of the new snapshot." stageName: allOf: - "$ref": "#/components/schemas/String" - description: The stage name to be associated with the new documentation snapshot. description: allOf: - "$ref": "#/components/schemas/String" - description: A description about the new documentation snapshot. description: Creates a new documentation version of a given API. EndpointConfiguration: type: object properties: types: allOf: - "$ref": "#/components/schemas/ListOfEndpointType" - description: A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE. vpcEndpointIds: allOf: - "$ref": "#/components/schemas/ListOfString" - description: A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type. description: 'The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. ' SecurityPolicy: type: string enum: - TLS_1_0 - TLS_1_2 MutualTlsAuthenticationInput: type: object properties: truststoreUri: allOf: - "$ref": "#/components/schemas/String" - description: An Amazon S3 resource ARN that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object. truststoreVersion: allOf: - "$ref": "#/components/schemas/String" - description: The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket. description: If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your custom domain name. CreateDomainNameRequest: type: object required: - domainName title: CreateDomainNameRequest properties: domainName: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The name of the DomainName resource." certificateName: allOf: - "$ref": "#/components/schemas/String" - description: The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name. certificateBody: allOf: - "$ref": "#/components/schemas/String" - description: "[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority." certificatePrivateKey: allOf: - "$ref": "#/components/schemas/String" - description: "[Deprecated] Your edge-optimized endpoint's domain name certificate's private key." certificateChain: allOf: - "$ref": "#/components/schemas/String" - description: "[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path." certificateArn: allOf: - "$ref": "#/components/schemas/String" - description: The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. regionalCertificateName: allOf: - "$ref": "#/components/schemas/String" - description: The user-friendly name of the certificate that will be used by regional endpoint for this domain name. regionalCertificateArn: allOf: - "$ref": "#/components/schemas/String" - description: The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source. endpointConfiguration: allOf: - "$ref": "#/components/schemas/EndpointConfiguration" - description: The endpoint configuration of this DomainName showing the endpoint types of the domain name. tags: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters. securityPolicy: allOf: - "$ref": "#/components/schemas/SecurityPolicy" - description: The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2. mutualTlsAuthentication: "$ref": "#/components/schemas/MutualTlsAuthenticationInput" ownershipVerificationCertificateArn: allOf: - "$ref": "#/components/schemas/String" - description: The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn. description: A request to create a new domain name. CreateModelRequest: type: object required: - name - contentType title: CreateModelRequest properties: name: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The name of the model. Must be alphanumeric." description: allOf: - "$ref": "#/components/schemas/String" - description: The description of the model. schema: allOf: - "$ref": "#/components/schemas/String" - description: The schema for the model. For application/json models, this should be JSON schema draft 4 model. contentType: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The content-type for the model." description: Request to add a new Model to an existing RestApi resource. CreateRequestValidatorRequest: type: object title: CreateRequestValidatorRequest properties: name: allOf: - "$ref": "#/components/schemas/String" - description: The name of the to-be-created RequestValidator. validateRequestBody: allOf: - "$ref": "#/components/schemas/Boolean" - description: A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false). validateRequestParameters: allOf: - "$ref": "#/components/schemas/Boolean" - description: A Boolean flag to indicate whether to validate request parameters, true, or not false. description: Creates a RequestValidator of a given RestApi. CreateResourceRequest: type: object required: - pathPart title: CreateResourceRequest properties: pathPart: allOf: - "$ref": "#/components/schemas/String" - description: The last path segment for this resource. description: Requests API Gateway to create a Resource resource. CreateRestApiRequest: type: object required: - name title: CreateRestApiRequest properties: name: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The name of the RestApi." description: allOf: - "$ref": "#/components/schemas/String" - description: The description of the RestApi. version: allOf: - "$ref": "#/components/schemas/String" - description: A version identifier for the API. cloneFrom: allOf: - "$ref": "#/components/schemas/String" - description: The ID of the RestApi that you want to clone from. binaryMediaTypes: allOf: - "$ref": "#/components/schemas/ListOfString" - description: The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. minimumCompressionSize: allOf: - "$ref": "#/components/schemas/NullableInteger" - description: A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. apiKeySource: allOf: - "$ref": "#/components/schemas/ApiKeySourceType" - description: 'The source of the API key for metering requests according to a usage plan. Valid values are:

HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

' endpointConfiguration: allOf: - "$ref": "#/components/schemas/EndpointConfiguration" - description: The endpoint configuration of this RestApi showing the endpoint types of the API. policy: allOf: - "$ref": "#/components/schemas/String" - description: A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration. tags: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters. disableExecuteApiEndpoint: allOf: - "$ref": "#/components/schemas/Boolean" - description: Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint. description: The POST Request to add a new RestApi resource to your collection. CreateStageRequest: type: object required: - stageName - deploymentId title: CreateStageRequest properties: stageName: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters." deploymentId: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The identifier of the Deployment resource for the Stage resource." description: allOf: - "$ref": "#/components/schemas/String" - description: The description of the Stage resource. cacheClusterEnabled: allOf: - "$ref": "#/components/schemas/Boolean" - description: Whether cache clustering is enabled for the stage. cacheClusterSize: allOf: - "$ref": "#/components/schemas/CacheClusterSize" - description: The stage's cache cluster size. variables: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. documentationVersion: allOf: - "$ref": "#/components/schemas/String" - description: The version of the associated API documentation. canarySettings: allOf: - "$ref": "#/components/schemas/CanarySettings" - description: The canary deployment settings of this stage. tracingEnabled: allOf: - "$ref": "#/components/schemas/Boolean" - description: Specifies whether active tracing with X-ray is enabled for the Stage. tags: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters. description: Requests API Gateway to create a Stage resource. CreateUsagePlanKeyRequest: type: object required: - keyId - keyType title: CreateUsagePlanKeyRequest properties: keyId: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The identifier of a UsagePlanKey resource for a plan customer." keyType: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The type of a UsagePlanKey resource for a plan customer." description: The POST request to create a usage plan key for adding an existing API key to a usage plan. ListOfApiStage: type: array items: "$ref": "#/components/schemas/ApiStage" QuotaSettings: type: object properties: limit: allOf: - "$ref": "#/components/schemas/Integer" - description: The maximum number of requests that can be made in a given time period. offset: allOf: - "$ref": "#/components/schemas/Integer" - description: The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday. period: allOf: - "$ref": "#/components/schemas/QuotaPeriodType" - description: The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH". description: Quotas configured for a usage plan. CreateUsagePlanRequest: type: object required: - name title: CreateUsagePlanRequest properties: name: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The name of the usage plan." description: allOf: - "$ref": "#/components/schemas/String" - description: The description of the usage plan. apiStages: allOf: - "$ref": "#/components/schemas/ListOfApiStage" - description: The associated API stages of the usage plan. throttle: allOf: - "$ref": "#/components/schemas/ThrottleSettings" - description: The throttling limits of the usage plan. quota: allOf: - "$ref": "#/components/schemas/QuotaSettings" - description: The quota of the usage plan. tags: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters. description: 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. CreateVpcLinkRequest: type: object required: - name - targetArns title: CreateVpcLinkRequest properties: name: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The name used to label and identify the VPC link." description: allOf: - "$ref": "#/components/schemas/String" - description: The description of the VPC link. targetArns: allOf: - "$ref": "#/components/schemas/ListOfString" - description: "[Required] The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner." tags: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters. description: 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. DeleteApiKeyRequest: type: object title: DeleteApiKeyRequest properties: {} description: A request to delete the ApiKey resource. DeleteAuthorizerRequest: type: object title: DeleteAuthorizerRequest properties: {} description: Request to delete an existing Authorizer resource. DeleteBasePathMappingRequest: type: object title: DeleteBasePathMappingRequest properties: {} description: A request to delete the BasePathMapping resource. DeleteClientCertificateRequest: type: object title: DeleteClientCertificateRequest properties: {} description: A request to delete the ClientCertificate resource. DeleteDeploymentRequest: type: object title: DeleteDeploymentRequest properties: {} description: Requests API Gateway to delete a Deployment resource. DeleteDocumentationPartRequest: type: object title: DeleteDocumentationPartRequest properties: {} description: Deletes an existing documentation part of an API. DeleteDocumentationVersionRequest: type: object title: DeleteDocumentationVersionRequest properties: {} description: Deletes an existing documentation version of an API. DeleteDomainNameRequest: type: object title: DeleteDomainNameRequest properties: {} description: A request to delete the DomainName resource. GatewayResponseType: type: string enum: - DEFAULT_4XX - DEFAULT_5XX - RESOURCE_NOT_FOUND - UNAUTHORIZED - INVALID_API_KEY - ACCESS_DENIED - AUTHORIZER_FAILURE - AUTHORIZER_CONFIGURATION_ERROR - INVALID_SIGNATURE - EXPIRED_TOKEN - MISSING_AUTHENTICATION_TOKEN - INTEGRATION_FAILURE - INTEGRATION_TIMEOUT - API_CONFIGURATION_ERROR - UNSUPPORTED_MEDIA_TYPE - BAD_REQUEST_PARAMETERS - BAD_REQUEST_BODY - REQUEST_TOO_LARGE - THROTTLED - QUOTA_EXCEEDED - WAF_FILTERED DeleteGatewayResponseRequest: type: object title: DeleteGatewayResponseRequest properties: {} description: Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings. DeleteIntegrationRequest: type: object title: DeleteIntegrationRequest properties: {} description: Represents a delete integration request. StatusCode: type: string pattern: "[1-5]\\d\\d" description: The status code. DeleteIntegrationResponseRequest: type: object title: DeleteIntegrationResponseRequest properties: {} description: Represents a delete integration response request. DeleteMethodRequest: type: object title: DeleteMethodRequest properties: {} description: Request to delete an existing Method resource. DeleteMethodResponseRequest: type: object title: DeleteMethodResponseRequest properties: {} description: A request to delete an existing MethodResponse resource. DeleteModelRequest: type: object title: DeleteModelRequest properties: {} description: Request to delete an existing model in an existing RestApi resource. DeleteRequestValidatorRequest: type: object title: DeleteRequestValidatorRequest properties: {} description: Deletes a specified RequestValidator of a given RestApi. DeleteResourceRequest: type: object title: DeleteResourceRequest properties: {} description: Request to delete a Resource. DeleteRestApiRequest: type: object title: DeleteRestApiRequest properties: {} description: Request to delete the specified API from your collection. DeleteStageRequest: type: object title: DeleteStageRequest properties: {} description: Requests API Gateway to delete a Stage resource. DeleteUsagePlanKeyRequest: type: object title: DeleteUsagePlanKeyRequest properties: {} description: The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan. DeleteUsagePlanRequest: type: object title: DeleteUsagePlanRequest properties: {} description: The DELETE request to delete a usage plan of a given plan Id. DeleteVpcLinkRequest: type: object title: DeleteVpcLinkRequest properties: {} description: Deletes an existing VpcLink of a specified identifier. PathToMapOfMethodSnapshot: type: object additionalProperties: "$ref": "#/components/schemas/MapOfMethodSnapshot" ListOfDeployment: type: array items: "$ref": "#/components/schemas/Deployment" ListOfDocumentationPart: type: array items: "$ref": "#/components/schemas/DocumentationPart" ListOfDocumentationVersion: type: array items: "$ref": "#/components/schemas/DocumentationVersion" DomainNameStatus: type: string enum: - AVAILABLE - UPDATING - PENDING - PENDING_CERTIFICATE_REIMPORT - PENDING_OWNERSHIP_VERIFICATION MutualTlsAuthentication: type: object properties: truststoreUri: allOf: - "$ref": "#/components/schemas/String" - description: An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object. truststoreVersion: allOf: - "$ref": "#/components/schemas/String" - description: The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket. truststoreWarnings: allOf: - "$ref": "#/components/schemas/ListOfString" - description: A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version. description: If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your custom domain name. ListOfDomainName: type: array items: "$ref": "#/components/schemas/DomainName" EndpointType: type: string enum: - REGIONAL - EDGE - PRIVATE description: The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region; and PRIVATE for private APIs. FlushStageAuthorizersCacheRequest: type: object title: FlushStageAuthorizersCacheRequest properties: {} description: Request to flush authorizer cache entries on a specified stage. FlushStageCacheRequest: type: object title: FlushStageCacheRequest properties: {} description: Requests API Gateway to flush a stage's cache. ListOfGatewayResponse: type: array items: "$ref": "#/components/schemas/GatewayResponse" GenerateClientCertificateRequest: type: object title: GenerateClientCertificateRequest properties: description: allOf: - "$ref": "#/components/schemas/String" - description: The description of the ClientCertificate. tags: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters. description: A request to generate a ClientCertificate resource. GetAccountRequest: type: object title: GetAccountRequest properties: {} description: Requests API Gateway to get information about the current Account resource. GetApiKeyRequest: type: object title: GetApiKeyRequest properties: {} description: A request to get information about the current ApiKey resource. GetApiKeysRequest: type: object title: GetApiKeysRequest properties: {} description: A request to get information about the current ApiKeys resource. GetAuthorizerRequest: type: object title: GetAuthorizerRequest properties: {} description: Request to describe an existing Authorizer resource. GetAuthorizersRequest: type: object title: GetAuthorizersRequest properties: {} description: Request to describe an existing Authorizers resource. GetBasePathMappingRequest: type: object title: GetBasePathMappingRequest properties: {} description: Request to describe a BasePathMapping resource. GetBasePathMappingsRequest: type: object title: GetBasePathMappingsRequest properties: {} description: A request to get information about a collection of BasePathMapping resources. GetClientCertificateRequest: type: object title: GetClientCertificateRequest properties: {} description: A request to get information about the current ClientCertificate resource. GetClientCertificatesRequest: type: object title: GetClientCertificatesRequest properties: {} description: A request to get information about a collection of ClientCertificate resources. GetDeploymentRequest: type: object title: GetDeploymentRequest properties: {} description: Requests API Gateway to get information about a Deployment resource. GetDeploymentsRequest: type: object title: GetDeploymentsRequest properties: {} description: Requests API Gateway to get information about a Deployments collection. GetDocumentationPartRequest: type: object title: GetDocumentationPartRequest properties: {} description: Gets a specified documentation part of a given API. LocationStatusType: type: string enum: - DOCUMENTED - UNDOCUMENTED GetDocumentationPartsRequest: type: object title: GetDocumentationPartsRequest properties: {} description: Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets). GetDocumentationVersionRequest: type: object title: GetDocumentationVersionRequest properties: {} description: Gets a documentation snapshot of an API. GetDocumentationVersionsRequest: type: object title: GetDocumentationVersionsRequest properties: {} description: Gets the documentation versions of an API. GetDomainNameRequest: type: object title: GetDomainNameRequest properties: {} description: Request to get the name of a DomainName resource. GetDomainNamesRequest: type: object title: GetDomainNamesRequest properties: {} description: Request to describe a collection of DomainName resources. GetExportRequest: type: object title: GetExportRequest properties: {} description: Request a new export of a RestApi for a particular Stage. GetGatewayResponseRequest: type: object title: GetGatewayResponseRequest properties: {} description: Gets a GatewayResponse of a specified response type on the given RestApi. GetGatewayResponsesRequest: type: object title: GetGatewayResponsesRequest properties: {} description: Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types. GetIntegrationRequest: type: object title: GetIntegrationRequest properties: {} description: Represents a request to get the integration configuration. GetIntegrationResponseRequest: type: object title: GetIntegrationResponseRequest properties: {} description: Represents a get integration response request. GetMethodRequest: type: object title: GetMethodRequest properties: {} description: Request to describe an existing Method resource. GetMethodResponseRequest: type: object title: GetMethodResponseRequest properties: {} description: Request to describe a MethodResponse resource. GetModelRequest: type: object title: GetModelRequest properties: {} description: Request to list information about a model in an existing RestApi resource. GetModelTemplateRequest: type: object title: GetModelTemplateRequest properties: {} description: Request to generate a sample mapping template used to transform the payload. GetModelsRequest: type: object title: GetModelsRequest properties: {} description: Request to list existing Models defined for a RestApi resource. GetRequestValidatorRequest: type: object title: GetRequestValidatorRequest properties: {} description: Gets a RequestValidator of a given RestApi. GetRequestValidatorsRequest: type: object title: GetRequestValidatorsRequest properties: {} description: Gets the RequestValidators collection of a given RestApi. GetResourceRequest: type: object title: GetResourceRequest properties: {} description: Request to list information about a resource. GetResourcesRequest: type: object title: GetResourcesRequest properties: {} description: Request to list information about a collection of resources. GetRestApiRequest: type: object title: GetRestApiRequest properties: {} description: 'The GET request to list an existing RestApi defined for your collection. ' GetRestApisRequest: type: object title: GetRestApisRequest properties: {} description: The GET request to list existing RestApis defined for your collection. GetSdkRequest: type: object title: GetSdkRequest properties: {} description: Request a new generated client SDK for a RestApi and Stage. GetSdkTypeRequest: type: object title: GetSdkTypeRequest properties: {} description: Get an SdkType instance. GetSdkTypesRequest: type: object title: GetSdkTypesRequest properties: {} description: Get the SdkTypes collection. GetStageRequest: type: object title: GetStageRequest properties: {} description: Requests API Gateway to get information about a Stage resource. GetStagesRequest: type: object title: GetStagesRequest properties: {} description: Requests API Gateway to get information about one or more Stage resources. GetTagsRequest: type: object title: GetTagsRequest properties: {} description: Gets the Tags collection for a given resource. GetUsagePlanKeyRequest: type: object title: GetUsagePlanKeyRequest properties: {} description: The GET request to get a usage plan key of a given key identifier. GetUsagePlanKeysRequest: type: object title: GetUsagePlanKeysRequest properties: {} description: The GET request to get all the usage plan keys representing the API keys added to a specified usage plan. GetUsagePlanRequest: type: object title: GetUsagePlanRequest properties: {} description: The GET request to get a usage plan of a given plan identifier. GetUsagePlansRequest: type: object title: GetUsagePlansRequest properties: {} description: The GET request to get all the usage plans of the caller's account. GetUsageRequest: type: object title: GetUsageRequest properties: {} description: The GET request to get the usage data of a usage plan in a specified time interval. GetVpcLinkRequest: type: object title: GetVpcLinkRequest properties: {} description: Gets a specified VPC link under the caller's account in a region. GetVpcLinksRequest: type: object title: GetVpcLinksRequest properties: {} description: Gets the VpcLinks collection under the caller's account in a selected region. ImportApiKeysRequest: type: object required: - body title: ImportApiKeysRequest properties: body: allOf: - "$ref": "#/components/schemas/Blob" - description: The payload of the POST request to import API keys. For the payload format, see API Key File Format. description: The POST request to import API keys from an external source, such as a CSV-formatted file. PutMode: type: string enum: - merge - overwrite ImportDocumentationPartsRequest: type: object required: - body title: ImportDocumentationPartsRequest properties: body: allOf: - "$ref": "#/components/schemas/Blob" - description: "[Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object." description: 'Import documentation parts from an external (e.g., OpenAPI) definition file. ' ImportRestApiRequest: type: object required: - body title: ImportRestApiRequest properties: body: allOf: - "$ref": "#/components/schemas/Blob" - description: "[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB." description: A POST request to import an API to API Gateway using an input of an API definition file. IntegrationType: type: string enum: - HTTP - AWS - MOCK - HTTP_PROXY - AWS_PROXY description: 'The integration type. The valid value is HTTP for integrating an API method with an HTTP backend; AWS with any AWS service endpoints; MOCK for testing without actually invoking the backend; HTTP_PROXY for integrating with the HTTP proxy integration; AWS_PROXY for integrating with the Lambda proxy integration. ' MapOfIntegrationResponse: type: object additionalProperties: "$ref": "#/components/schemas/IntegrationResponse" TlsConfig: type: object properties: insecureSkipVerification: allOf: - "$ref": "#/components/schemas/Boolean" - description: Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. This isnâ€™t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for HTTP and HTTP_PROXY integrations. Long: type: integer ListOfLong: type: array items: "$ref": "#/components/schemas/Long" ListOfModel: type: array items: "$ref": "#/components/schemas/Model" ListOfPatchOperation: type: array description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list. items: "$ref": "#/components/schemas/PatchOperation" ListOfRequestValidator: type: array items: "$ref": "#/components/schemas/RequestValidator" ListOfResource: type: array items: "$ref": "#/components/schemas/Resource" ListOfRestApi: type: array items: "$ref": "#/components/schemas/RestApi" SdkConfigurationProperty: type: object properties: name: allOf: - "$ref": "#/components/schemas/String" - description: The name of a an SdkType configuration property. friendlyName: allOf: - "$ref": "#/components/schemas/String" - description: The user-friendly name of an SdkType configuration property. description: allOf: - "$ref": "#/components/schemas/String" - description: The description of an SdkType configuration property. required: allOf: - "$ref": "#/components/schemas/Boolean" - description: A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false). defaultValue: allOf: - "$ref": "#/components/schemas/String" - description: The default value of an SdkType configuration property. description: A configuration property of an SDK type. ListOfSdkConfigurationProperty: type: array items: "$ref": "#/components/schemas/SdkConfigurationProperty" ListOfSdkType: type: array items: "$ref": "#/components/schemas/SdkType" ListOfStage: type: array items: "$ref": "#/components/schemas/Stage" ListOfUsage: type: array items: "$ref": "#/components/schemas/ListOfLong" ListOfUsagePlan: type: array items: "$ref": "#/components/schemas/UsagePlan" ListOfUsagePlanKey: type: array items: "$ref": "#/components/schemas/UsagePlanKey" ListOfVpcLink: type: array items: "$ref": "#/components/schemas/VpcLink" MapOfKeyUsages: type: object additionalProperties: "$ref": "#/components/schemas/ListOfUsage" MapOfMethod: type: object additionalProperties: "$ref": "#/components/schemas/Method" MapOfMethodResponse: type: object additionalProperties: "$ref": "#/components/schemas/MethodResponse" MethodSetting: type: object properties: metricsEnabled: allOf: - "$ref": "#/components/schemas/Boolean" - description: Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean. loggingLevel: allOf: - "$ref": "#/components/schemas/String" - description: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events. dataTraceEnabled: allOf: - "$ref": "#/components/schemas/Boolean" - description: Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean. throttlingBurstLimit: allOf: - "$ref": "#/components/schemas/Integer" - description: Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer. throttlingRateLimit: allOf: - "$ref": "#/components/schemas/Double" - description: Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double. cachingEnabled: allOf: - "$ref": "#/components/schemas/Boolean" - description: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean. cacheTtlInSeconds: allOf: - "$ref": "#/components/schemas/Integer" - description: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer. cacheDataEncrypted: allOf: - "$ref": "#/components/schemas/Boolean" - description: Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean. requireAuthorizationForCacheControl: allOf: - "$ref": "#/components/schemas/Boolean" - description: Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean. unauthorizedCacheControlHeaderStrategy: allOf: - "$ref": "#/components/schemas/UnauthorizedCacheControlHeaderStrategy" - description: Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER. description: Specifies the method setting properties. MapOfMethodSettings: type: object additionalProperties: "$ref": "#/components/schemas/MethodSetting" MethodSnapshot: type: object properties: authorizationType: allOf: - "$ref": "#/components/schemas/String" - description: The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool. apiKeyRequired: allOf: - "$ref": "#/components/schemas/Boolean" - description: Specifies whether the method requires a valid ApiKey. description: Represents a summary of a Method resource, given a particular date and time. MapOfMethodSnapshot: type: object additionalProperties: "$ref": "#/components/schemas/MethodSnapshot" MapOfStringToBoolean: type: object additionalProperties: "$ref": "#/components/schemas/NullableBoolean" MapOfStringToList: type: object additionalProperties: "$ref": "#/components/schemas/ListOfString" UnauthorizedCacheControlHeaderStrategy: type: string enum: - FAIL_WITH_403 - SUCCEED_WITH_RESPONSE_HEADER - SUCCEED_WITHOUT_RESPONSE_HEADER Op: type: string enum: - add - remove - replace - move - copy - test PutGatewayResponseRequest: type: object title: PutGatewayResponseRequest properties: statusCode: allOf: - "$ref": "#/components/schemas/StatusCode" - description: The HTTP status code of the GatewayResponse. responseParameters: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: "

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

" responseTemplates: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: "

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

" description: Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi. PutIntegrationRequest: type: object required: - type title: PutIntegrationRequest properties: type: allOf: - "$ref": "#/components/schemas/IntegrationType" - description: "[Required] Specifies a put integration input's type." integrationHttpMethod: allOf: - "$ref": "#/components/schemas/String" - xml: name: httpMethod description: Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required. uri: allOf: - "$ref": "#/components/schemas/String" - description:

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

connectionType: allOf: - "$ref": "#/components/schemas/ConnectionType" - description: The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET. connectionId: allOf: - "$ref": "#/components/schemas/String" - description: The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise. credentials: allOf: - "$ref": "#/components/schemas/String" - description: Specifies whether credentials are required for a put integration. requestParameters: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name. requestTemplates: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. passthroughBehavior: allOf: - "$ref": "#/components/schemas/String" - description: "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.
NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

" cacheNamespace: allOf: - "$ref": "#/components/schemas/String" - description: Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources. cacheKeyParameters: allOf: - "$ref": "#/components/schemas/ListOfString" - description: A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters. contentHandling: allOf: - "$ref": "#/components/schemas/ContentHandlingStrategy" - description: "

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

" timeoutInMillis: allOf: - "$ref": "#/components/schemas/NullableInteger" - description: Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. tlsConfig: "$ref": "#/components/schemas/TlsConfig" description: Sets up a method's integration. PutIntegrationResponseRequest: type: object title: PutIntegrationResponseRequest properties: selectionPattern: allOf: - "$ref": "#/components/schemas/String" - description: Specifies the selection pattern of a put integration response. responseParameters: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix. responseTemplates: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: Specifies a put integration response's templates. contentHandling: allOf: - "$ref": "#/components/schemas/ContentHandlingStrategy" - description: "

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

" description: Represents a put integration response request. PutMethodRequest: type: object required: - authorizationType title: PutMethodRequest properties: authorizationType: allOf: - "$ref": "#/components/schemas/String" - description: "[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool." authorizerId: allOf: - "$ref": "#/components/schemas/String" - description: Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer. apiKeyRequired: allOf: - "$ref": "#/components/schemas/Boolean" - description: Specifies whether the method required a valid ApiKey. operationName: allOf: - "$ref": "#/components/schemas/String" - description: A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example. requestParameters: allOf: - "$ref": "#/components/schemas/MapOfStringToBoolean" - description: A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates. requestModels: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value. requestValidatorId: allOf: - "$ref": "#/components/schemas/String" - description: The identifier of a RequestValidator for validating the method request. authorizationScopes: allOf: - "$ref": "#/components/schemas/ListOfString" - description: A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes. description: Request to add a method to an existing Resource resource. PutMethodResponseRequest: type: object title: PutMethodResponseRequest properties: responseParameters: allOf: - "$ref": "#/components/schemas/MapOfStringToBoolean" - description: A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.) responseModels: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value. description: Request to add a MethodResponse to an existing Method resource. PutRestApiRequest: type: object required: - body title: PutRestApiRequest properties: body: allOf: - "$ref": "#/components/schemas/Blob" - description: "[Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB." description: A PUT request to update an existing API, with external API definitions specified as the request body. TagResourceRequest: type: object required: - tags title: TagResourceRequest properties: tags: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: "[Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters." description: Adds or updates a tag on a given resource. TestInvokeAuthorizerRequest: type: object title: TestInvokeAuthorizerRequest properties: headers: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: "[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified." multiValueHeaders: allOf: - "$ref": "#/components/schemas/MapOfStringToList" - description: "[Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified." pathWithQueryString: allOf: - "$ref": "#/components/schemas/String" - description: "[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters." body: allOf: - "$ref": "#/components/schemas/String" - description: "[Optional] The simulated request body of an incoming invocation request." stageVariables: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: A key-value map of stage variables to simulate an invocation on a deployed Stage. additionalContext: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: "[Optional] A key-value map of additional context variables." description: Make a request to simulate the execution of an Authorizer. TestInvokeMethodRequest: type: object title: TestInvokeMethodRequest properties: pathWithQueryString: allOf: - "$ref": "#/components/schemas/String" - description: The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters. body: allOf: - "$ref": "#/components/schemas/String" - description: The simulated request body of an incoming invocation request. headers: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: A key-value map of headers to simulate an incoming invocation request. multiValueHeaders: allOf: - "$ref": "#/components/schemas/MapOfStringToList" - description: The headers as a map from string to list of values to simulate an incoming invocation request. clientCertificateId: allOf: - "$ref": "#/components/schemas/String" - description: A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint. stageVariables: allOf: - "$ref": "#/components/schemas/MapOfStringToString" - description: A key-value map of stage variables to simulate an invocation on a deployed Stage. description: Make a request to simulate the execution of a Method. UntagResourceRequest: type: object title: UntagResourceRequest properties: {} description: Removes a tag from a given resource. UpdateAccountRequest: type: object title: UpdateAccountRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Requests API Gateway to change information about the current Account resource. UpdateApiKeyRequest: type: object title: UpdateApiKeyRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: A request to change information about an ApiKey resource. UpdateAuthorizerRequest: type: object title: UpdateAuthorizerRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Request to update an existing Authorizer resource. UpdateBasePathMappingRequest: type: object title: UpdateBasePathMappingRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: A request to change information about the BasePathMapping resource. UpdateClientCertificateRequest: type: object title: UpdateClientCertificateRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: A request to change information about an ClientCertificate resource. UpdateDeploymentRequest: type: object title: UpdateDeploymentRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Requests API Gateway to change information about a Deployment resource. UpdateDocumentationPartRequest: type: object title: UpdateDocumentationPartRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Updates an existing documentation part of a given API. UpdateDocumentationVersionRequest: type: object title: UpdateDocumentationVersionRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Updates an existing documentation version of an API. UpdateDomainNameRequest: type: object title: UpdateDomainNameRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: A request to change information about the DomainName resource. UpdateGatewayResponseRequest: type: object title: UpdateGatewayResponseRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Updates a GatewayResponse of a specified response type on the given RestApi. UpdateIntegrationRequest: type: object title: UpdateIntegrationRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Represents an update integration request. UpdateIntegrationResponseRequest: type: object title: UpdateIntegrationResponseRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Represents an update integration response request. UpdateMethodRequest: type: object title: UpdateMethodRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Request to update an existing Method resource. UpdateMethodResponseRequest: type: object title: UpdateMethodResponseRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: A request to update an existing MethodResponse resource. UpdateModelRequest: type: object title: UpdateModelRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Request to update an existing model in an existing RestApi resource. UpdateRequestValidatorRequest: type: object title: UpdateRequestValidatorRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Updates a RequestValidator of a given RestApi. UpdateResourceRequest: type: object title: UpdateResourceRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Request to change information about a Resource resource. UpdateRestApiRequest: type: object title: UpdateRestApiRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Request to update an existing RestApi resource in your collection. UpdateStageRequest: type: object title: UpdateStageRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Requests API Gateway to change information about a Stage resource. UpdateUsagePlanRequest: type: object title: UpdateUsagePlanRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: The PATCH request to update a usage plan of a given plan Id. UpdateUsageRequest: type: object title: UpdateUsageRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key. UpdateVpcLinkRequest: type: object title: UpdateVpcLinkRequest properties: patchOperations: allOf: - "$ref": "#/components/schemas/ListOfPatchOperation" - description: A list of update operations to be applied to the specified resource and in the order specified in this list. description: Updates an existing VpcLink of a specified identifier. VpcLinkStatus: type: string enum: - AVAILABLE - PENDING - DELETING - FAILED x-policies: "/apikeys": API Key "/restapis/{restapi_id}/authorizers": Authorizers "/domainnames/{domain_name}/basepathmappings": Domain Mapping "/restapis/{restapi_id}/deployments": Deployments "/restapis/{restapi_id}/documentation/parts": Documentation Parts "/restapis/{restapi_id}/documentation/versions": Documentation Versions "/domainnames": Domain Names "/restapis/{restapi_id}/models": Models "/restapis/{restapi_id}/requestvalidators": Request Validation "/restapis/{restapi_id}/resources/{parent_id}": Resource Parents "/restapis": APIs "/restapis/{restapi_id}/stages": Stages "/usageplans": Plans "/usageplans/{usageplanId}/keys": Plan Keys "/vpclinks": Virtual Private Networks "/apikeys/{api_Key}": API Key "/restapis/{restapi_id}/authorizers/{authorizer_id}": Authorizers "/domainnames/{domain_name}/basepathmappings/{base_path}": Domain Names "/clientcertificates/{clientcertificate_id}": Certificates "/restapis/{restapi_id}/deployments/{deployment_id}": Deploymeents "/restapis/{restapi_id}/documentation/parts/{part_id}": Documentation Parts "/restapis/{restapi_id}/documentation/versions/{doc_version}": Documentation Versions "/domainnames/{domain_name}": Domain Names "/restapis/{restapi_id}/gatewayresponses/{response_type}": Response Types "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration": HTTP Integrations "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}": Response Status Codes "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}": Methods "/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}": Response Status Codes "/restapis/{restapi_id}/models/{model_name}": Models "/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}": Request Validation "/restapis/{restapi_id}/resources/{resource_id}": Resources "/restapis/{restapi_id}": APIs "/restapis/{restapi_id}/stages/{stage_name}": Stages "/usageplans/{usageplanId}": Plans "/usageplans/{usageplanId}/keys/{keyId}": Plan Keys "/vpclinks/{vpclink_id}": Virtual Private Networks "/restapis/{restapi_id}/stages/{stage_name}/cache/authorizers": Authorizer Cache "/restapis/{restapi_id}/stages/{stage_name}/cache/data": Cache Data "/clientcertificates": Client Certificates "/account": Accounts "/restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}": Stage Exports "/restapis/{restapi_id}/gatewayresponses": Gateway Responses "/restapis/{restapi_id}/models/{model_name}/default_template": Default Templates "/restapis/{restapi_id}/resources": Resources "/restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}": SDKs "/sdktypes/{sdktype_id}": SDK Types "/sdktypes": SDK Types "/tags/{resource_arn}": Tags "/usageplans/{usageplanId}/usage#startDate&endDate": Plan Usage "/apikeys#mode=import&format": API Keys "/restapis#mode=import": APIs "/tags/{resource_arn}#tagKeys": Tags "/usageplans/{usageplanId}/keys/{keyId}/usage": Key Usage security: - hmac: []