Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
", "operations": { "CreateApiKey": "Create an ApiKey resource.
", "CreateAuthorizer": "Adds a new Authorizer resource to an existing RestApi resource.
", "CreateBasePathMapping": "Creates a new BasePathMapping resource.
", "CreateDeployment": "Creates a Deployment resource, which makes a specified RestApi callable over the internet.
", "CreateDocumentationPart": null, "CreateDocumentationVersion": null, "CreateDomainName": "Creates a new domain name.
", "CreateModel": "Adds a new Model resource to an existing RestApi resource.
", "CreateRequestValidator": "Creates a ReqeustValidator of a given RestApi.
", "CreateResource": "Creates a Resource resource.
", "CreateRestApi": "Creates a new RestApi resource.
", "CreateStage": "Creates a new Stage resource that references a pre-existing Deployment for the API.
", "CreateUsagePlan": "Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
", "CreateUsagePlanKey": "Creates a usage plan key for adding an existing API key to a usage plan.
", "CreateVpcLink": "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.
", "DeleteApiKey": "Deletes the ApiKey resource.
", "DeleteAuthorizer": "Deletes an existing Authorizer resource.
", "DeleteBasePathMapping": "Deletes the BasePathMapping resource.
", "DeleteClientCertificate": "Deletes the ClientCertificate resource.
", "DeleteDeployment": "Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
", "DeleteDocumentationPart": null, "DeleteDocumentationVersion": null, "DeleteDomainName": "Deletes the DomainName resource.
", "DeleteGatewayResponse": "Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
", "DeleteIntegration": "Represents a delete integration.
", "DeleteIntegrationResponse": "Represents a delete integration response.
", "DeleteMethod": "Deletes an existing Method resource.
", "DeleteMethodResponse": "Deletes an existing MethodResponse resource.
", "DeleteModel": "Deletes a model.
", "DeleteRequestValidator": "Deletes a RequestValidator of a given RestApi.
", "DeleteResource": "Deletes a Resource resource.
", "DeleteRestApi": "Deletes the specified API.
", "DeleteStage": "Deletes a Stage resource.
", "DeleteUsagePlan": "Deletes a usage plan of a given plan Id.
", "DeleteUsagePlanKey": "Deletes a usage plan key and remove the underlying API key from the associated usage plan.
", "DeleteVpcLink": "Deletes an existing VpcLink of a specified identifier.
", "FlushStageAuthorizersCache": "Flushes all authorizer cache entries on a stage.
", "FlushStageCache": "Flushes a stage's cache.
", "GenerateClientCertificate": "Generates a ClientCertificate resource.
", "GetAccount": "Gets information about the current Account resource.
", "GetApiKey": "Gets information about the current ApiKey resource.
", "GetApiKeys": "Gets information about the current ApiKeys resource.
", "GetAuthorizer": "Describe an existing Authorizer resource.
", "GetAuthorizers": "Describe an existing Authorizers resource.
", "GetBasePathMapping": "Describe a BasePathMapping resource.
", "GetBasePathMappings": "Represents a collection of BasePathMapping resources.
", "GetClientCertificate": "Gets information about the current ClientCertificate resource.
", "GetClientCertificates": "Gets a collection of ClientCertificate resources.
", "GetDeployment": "Gets information about a Deployment resource.
", "GetDeployments": "Gets information about a Deployments collection.
", "GetDocumentationPart": null, "GetDocumentationParts": null, "GetDocumentationVersion": null, "GetDocumentationVersions": null, "GetDomainName": "Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
", "GetDomainNames": "Represents a collection of DomainName resources.
", "GetExport": "Exports a deployed version of a RestApi in a specified format.
", "GetGatewayResponse": "Gets a GatewayResponse of a specified response type on the given RestApi.
", "GetGatewayResponses": "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.
", "GetIntegration": "Get the integration settings.
", "GetIntegrationResponse": "Represents a get integration response.
", "GetMethod": "Describe an existing Method resource.
", "GetMethodResponse": "Describes a MethodResponse resource.
", "GetModel": "Describes an existing model defined for a RestApi resource.
", "GetModelTemplate": "Generates a sample mapping template that can be used to transform a payload into the structure of a model.
", "GetModels": "Describes existing Models defined for a RestApi resource.
", "GetRequestValidator": "Gets a RequestValidator of a given RestApi.
", "GetRequestValidators": "Gets the RequestValidators collection of a given RestApi.
", "GetResource": "Lists information about a resource.
", "GetResources": "Lists information about a collection of Resource resources.
", "GetRestApi": "Lists the RestApi resource in the collection.
", "GetRestApis": "Lists the RestApis resources for your collection.
", "GetSdk": "Generates a client SDK for a RestApi and Stage.
", "GetSdkType": null, "GetSdkTypes": null, "GetStage": "Gets information about a Stage resource.
", "GetStages": "Gets information about one or more Stage resources.
", "GetUsage": "Gets the usage data of a usage plan in a specified time interval.
", "GetUsagePlan": "Gets a usage plan of a given plan identifier.
", "GetUsagePlanKey": "Gets a usage plan key of a given key identifier.
", "GetUsagePlanKeys": "Gets all the usage plan keys representing the API keys added to a specified usage plan.
", "GetUsagePlans": "Gets all the usage plans of the caller's account.
", "GetVpcLink": "Gets a specified VPC link under the caller's account in a region.
", "GetVpcLinks": "Gets the VpcLinks collection under the caller's account in a selected region.
", "ImportApiKeys": "Import API keys from an external source, such as a CSV-formatted file.
", "ImportDocumentationParts": null, "ImportRestApi": "A feature of the API Gateway control service for creating a new API from an external API definition file.
", "PutGatewayResponse": "Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
", "PutIntegration": "Sets up a method's integration.
", "PutIntegrationResponse": "Represents a put integration.
", "PutMethod": "Add a method to an existing Resource resource.
", "PutMethodResponse": "Adds a MethodResponse to an existing Method resource.
", "PutRestApi": "A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
", "TestInvokeAuthorizer": "Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
", "TestInvokeMethod": "Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
", "UpdateAccount": "Changes information about the current Account resource.
", "UpdateApiKey": "Changes information about an ApiKey resource.
", "UpdateAuthorizer": "Updates an existing Authorizer resource.
", "UpdateBasePathMapping": "Changes information about the BasePathMapping resource.
", "UpdateClientCertificate": "Changes information about an ClientCertificate resource.
", "UpdateDeployment": "Changes information about a Deployment resource.
", "UpdateDocumentationPart": null, "UpdateDocumentationVersion": null, "UpdateDomainName": "Changes information about the DomainName resource.
", "UpdateGatewayResponse": "Updates a GatewayResponse of a specified response type on the given RestApi.
", "UpdateIntegration": "Represents an update integration.
", "UpdateIntegrationResponse": "Represents an update integration response.
", "UpdateMethod": "Updates an existing Method resource.
", "UpdateMethodResponse": "Updates an existing MethodResponse resource.
", "UpdateModel": "Changes information about a model.
", "UpdateRequestValidator": "Updates a RequestValidator of a given RestApi.
", "UpdateResource": "Changes information about a Resource resource.
", "UpdateRestApi": "Changes information about the specified API.
", "UpdateStage": "Changes information about a Stage resource.
", "UpdateUsage": "Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
", "UpdateUsagePlan": "Updates a usage plan of a given plan Id.
", "UpdateVpcLink": "Updates an existing VpcLink of a specified identifier.
" }, "shapes": { "AccessLogSettings": { "base": "Access log settings, including the access log format and access log destination ARN.
", "refs": { "Stage$accessLogSettings": "Settings for logging access in this stage.
" } }, "Account": { "base": "Represents an AWS account that is associated with API Gateway.
To view the account info, call GET on this resource.
The following exception may be thrown when the request fails.
For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes
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} The successful response returns a 200 OK status code and a payload similar to the following:
{ \"_links\": { \"curies\": { \"href\": \"http://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.
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
", "refs": { "ListOfApiKey$member": null } }, "ApiKeyIds": { "base": "The identifier of an ApiKey used in a UsagePlan.
", "refs": { } }, "ApiKeys": { "base": "Represents a collection of API keys as represented by an ApiKeys resource.
", "refs": { } }, "ApiKeysFormat": { "base": null, "refs": { "ImportApiKeysRequest$format": "A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.
API stage name of the associated API stage in a usage plan.
", "refs": { "ListOfApiStage$member": null } }, "Authorizer": { "base": "Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
", "refs": { "ListOfAuthorizer$member": null } }, "AuthorizerType": { "base": "[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.
[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.
[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.
Represents a collection of Authorizer resources.
", "refs": { } }, "BadRequestException": { "base": "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
", "refs": { } }, "BasePathMapping": { "base": "Represents the base path that callers of the API must provide as part of the URL after the domain name.
BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.Represents a collection of BasePathMapping resources.
", "refs": { } }, "Blob": { "base": null, "refs": { "ExportResponse$body": "The binary blob response to GetExport, which contains the export.
", "ImportApiKeysRequest$body": "The payload of the POST request to import API keys. For the payload format, see API Key File Format.
", "ImportDocumentationPartsRequest$body": "[Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.
", "ImportRestApiRequest$body": "The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.
", "PutRestApiRequest$body": "The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.
", "SdkResponse$body": "The binary blob response to GetSdk, which contains the generated SDK.
" } }, "Boolean": { "base": null, "refs": { "ApiKey$enabled": "Specifies whether the API Key can be used by callers.
", "CanarySettings$useStageCache": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
", "CreateApiKeyRequest$enabled": "Specifies whether the ApiKey can be used by callers.
", "CreateApiKeyRequest$generateDistinctId": "Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).
A Boolean flag to indicate whether to validate request parameters, true, or not false.
Whether cache clustering is enabled for the stage.
", "DeploymentCanarySettings$useStageCache": "A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
", "GatewayResponse$defaultResponse": "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.
A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.
A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.
A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.
A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.
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.
Specifies whether data trace logging is enabled for this method, which effects 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.
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.
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.
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.
Specifies whether the method requires a valid ApiKey.
", "PutMethodRequest$apiKeyRequired": "Specifies whether the method required a valid ApiKey.
", "PutRestApiRequest$failOnWarnings": "A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
", "RequestValidator$validateRequestParameters": "A Boolean flag to indicate whether to validate request parameters (true) or not (false).
A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).
Specifies whether a cache cluster is enabled for the stage.
" } }, "CacheClusterSize": { "base": "Returns the size of the CacheCluster.
", "refs": { "CreateDeploymentRequest$cacheClusterSize": "Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
", "CreateStageRequest$cacheClusterSize": "The stage's cache cluster size.
", "Stage$cacheClusterSize": "The size of the cache cluster for the stage, if enabled.
" } }, "CacheClusterStatus": { "base": "Returns the status of the CacheCluster.
", "refs": { "Stage$cacheClusterStatus": "The status of the cache cluster for the stage, if enabled.
" } }, "CanarySettings": { "base": "Configuration settings of a canary deployment.
", "refs": { "CreateStageRequest$canarySettings": "The canary deployment settings of this stage.
", "Stage$canarySettings": "Settings for the canary deployment in this stage.
" } }, "ClientCertificate": { "base": "Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Represents a collection of ClientCertificate resources.
", "refs": { } }, "ConflictException": { "base": "The request configuration has conflicts. For details, see the accompanying error message.
", "refs": { } }, "ConnectionType": { "base": null, "refs": { "Integration$connectionType": "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 an network load balancer in a VPC. The default value is INTERNET.
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 an network load balancer in a VPC. The default value is INTERNET.
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 passthroughBehaviors is configured to support payload pass-through.
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.
", "PutIntegrationRequest$contentHandling": "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 passthroughBehaviors is configured to support payload pass-through.
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.
" } }, "CreateApiKeyRequest": { "base": "Request to create an ApiKey resource.
", "refs": { } }, "CreateAuthorizerRequest": { "base": "Request to add a new Authorizer to an existing RestApi resource.
", "refs": { } }, "CreateBasePathMappingRequest": { "base": "Requests API Gateway to create a new BasePathMapping resource.
", "refs": { } }, "CreateDeploymentRequest": { "base": "Requests API Gateway to create a Deployment resource.
", "refs": { } }, "CreateDocumentationPartRequest": { "base": "Creates a new documentation part of a given API.
", "refs": { } }, "CreateDocumentationVersionRequest": { "base": "Creates a new documentation version of a given API.
", "refs": { } }, "CreateDomainNameRequest": { "base": "A request to create a new domain name.
", "refs": { } }, "CreateModelRequest": { "base": "Request to add a new Model to an existing RestApi resource.
", "refs": { } }, "CreateRequestValidatorRequest": { "base": "Creates a RequestValidator of a given RestApi.
", "refs": { } }, "CreateResourceRequest": { "base": "Requests API Gateway to create a Resource resource.
", "refs": { } }, "CreateRestApiRequest": { "base": "The POST Request to add a new RestApi resource to your collection.
", "refs": { } }, "CreateStageRequest": { "base": "Requests API Gateway to create a Stage resource.
", "refs": { } }, "CreateUsagePlanKeyRequest": { "base": "The POST request to create a usage plan key for adding an existing API key to a usage plan.
", "refs": { } }, "CreateUsagePlanRequest": { "base": "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.
", "refs": { } }, "CreateVpcLinkRequest": { "base": "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.
", "refs": { } }, "DeleteApiKeyRequest": { "base": "A request to delete the ApiKey resource.
", "refs": { } }, "DeleteAuthorizerRequest": { "base": "Request to delete an existing Authorizer resource.
", "refs": { } }, "DeleteBasePathMappingRequest": { "base": "A request to delete the BasePathMapping resource.
", "refs": { } }, "DeleteClientCertificateRequest": { "base": "A request to delete the ClientCertificate resource.
", "refs": { } }, "DeleteDeploymentRequest": { "base": "Requests API Gateway to delete a Deployment resource.
", "refs": { } }, "DeleteDocumentationPartRequest": { "base": "Deletes an existing documentation part of an API.
", "refs": { } }, "DeleteDocumentationVersionRequest": { "base": "Deletes an existing documentation version of an API.
", "refs": { } }, "DeleteDomainNameRequest": { "base": "A request to delete the DomainName resource.
", "refs": { } }, "DeleteGatewayResponseRequest": { "base": "Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
", "refs": { } }, "DeleteIntegrationRequest": { "base": "Represents a delete integration request.
", "refs": { } }, "DeleteIntegrationResponseRequest": { "base": "Represents a delete integration response request.
", "refs": { } }, "DeleteMethodRequest": { "base": "Request to delete an existing Method resource.
", "refs": { } }, "DeleteMethodResponseRequest": { "base": "A request to delete an existing MethodResponse resource.
", "refs": { } }, "DeleteModelRequest": { "base": "Request to delete an existing model in an existing RestApi resource.
", "refs": { } }, "DeleteRequestValidatorRequest": { "base": "Deletes a specified RequestValidator of a given RestApi.
", "refs": { } }, "DeleteResourceRequest": { "base": "Request to delete a Resource.
", "refs": { } }, "DeleteRestApiRequest": { "base": "Request to delete the specified API from your collection.
", "refs": { } }, "DeleteStageRequest": { "base": "Requests API Gateway to delete a Stage resource.
", "refs": { } }, "DeleteUsagePlanKeyRequest": { "base": "The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
", "refs": { } }, "DeleteUsagePlanRequest": { "base": "The DELETE request to delete a usage plan of a given plan Id.
", "refs": { } }, "DeleteVpcLinkRequest": { "base": "Deletes an existing VpcLink of a specified identifier.
", "refs": { } }, "Deployment": { "base": "An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
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}).The input configuration for a canary deployment.
", "refs": { "CreateDeploymentRequest$canarySettings": "The input configuration for the canary deployment when the deployment is a canary release deployment.
" } }, "Deployments": { "base": "Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.
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.A documentation part for a targeted API entity.
A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.
The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.
A collection of the imported DocumentationPart identifiers.
Specifies the target API entity to which the documentation applies.
", "refs": { "CreateDocumentationPartRequest$location": "[Required] The location of the targeted API entity of the to-be-created documentation part.
", "DocumentationPart$location": "The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
" } }, "DocumentationPartLocationStatusCode": { "base": null, "refs": { "DocumentationPartLocation$statusCode": "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.
The type of API entity to which the documentation content applies. It is a valid and required field for API entity types of 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.
The type of API entities of the to-be-retrieved documentation parts.
" } }, "DocumentationParts": { "base": "The collection of documentation parts of an API.
A snapshot of the documentation of an API.
Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.
The collection of documentation snapshots of an API.
Use the DocumentationVersions to manage documentation snapshots associated with various API stages.
Represents a custom domain name as a user-friendly host name of an API (RestApi).
When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.
Represents a collection of DomainName resources.
", "refs": { } }, "Double": { "base": null, "refs": { "CanarySettings$percentTraffic": "The percent (0-100) of traffic diverted to a canary deployment.
", "DeploymentCanarySettings$percentTraffic": "The percentage (0.0-100.0) of traffic routed to the canary deployment.
", "MethodSetting$throttlingRateLimit": "Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.
The API request steady-state rate limit.
" } }, "EndpointConfiguration": { "base": "The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
", "refs": { "CreateDomainNameRequest$endpointConfiguration": "The endpoint configuration of this DomainName showing the endpoint types of the domain name.
", "CreateRestApiRequest$endpointConfiguration": "The endpoint configuration of this RestApi showing the endpoint types of the API.
", "DomainName$endpointConfiguration": "The endpoint configuration of this DomainName showing the endpoint types of the domain name.
", "RestApi$endpointConfiguration": "The endpoint configuration of this RestApi showing the endpoint types of the API.
" } }, "EndpointType": { "base": "The endpoint type. The valid value is EDGE for edge-optimized API setup, most suitable for mobile applications, REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region
The binary blob response to GetExport, which contains the generated SDK.
", "refs": { } }, "FlushStageAuthorizersCacheRequest": { "base": "Request to flush authorizer cache entries on a specified stage.
", "refs": { } }, "FlushStageCacheRequest": { "base": "Requests API Gateway to flush a stage's cache.
", "refs": { } }, "GatewayResponse": { "base": "A gateway response of a given response type and status code, with optional response parameters and mapping templates.
This example shows how to get a gateway response of the MISSING_AUTHNETICATION_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.
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\" }The response type of the associated GatewayResponse. Valid values are
The response type of the associated GatewayResponse. Valid values are
The response type of the associated GatewayResponse. Valid values are
The response type of the associated GatewayResponse. Valid values are
The response type of the associated GatewayResponse. Valid values are
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.
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 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\" } ] } }A request to generate a ClientCertificate resource.
", "refs": { } }, "GetAccountRequest": { "base": "Requests API Gateway to get information about the current Account resource.
", "refs": { } }, "GetApiKeyRequest": { "base": "A request to get information about the current ApiKey resource.
", "refs": { } }, "GetApiKeysRequest": { "base": "A request to get information about the current ApiKeys resource.
", "refs": { } }, "GetAuthorizerRequest": { "base": "Request to describe an existing Authorizer resource.
", "refs": { } }, "GetAuthorizersRequest": { "base": "Request to describe an existing Authorizers resource.
", "refs": { } }, "GetBasePathMappingRequest": { "base": "Request to describe a BasePathMapping resource.
", "refs": { } }, "GetBasePathMappingsRequest": { "base": "A request to get information about a collection of BasePathMapping resources.
", "refs": { } }, "GetClientCertificateRequest": { "base": "A request to get information about the current ClientCertificate resource.
", "refs": { } }, "GetClientCertificatesRequest": { "base": "A request to get information about a collection of ClientCertificate resources.
", "refs": { } }, "GetDeploymentRequest": { "base": "Requests API Gateway to get information about a Deployment resource.
", "refs": { } }, "GetDeploymentsRequest": { "base": "Requests API Gateway to get information about a Deployments collection.
", "refs": { } }, "GetDocumentationPartRequest": { "base": "Gets a specified documentation part of a given API.
", "refs": { } }, "GetDocumentationPartsRequest": { "base": "Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
", "refs": { } }, "GetDocumentationVersionRequest": { "base": "Gets a documentation snapshot of an API.
", "refs": { } }, "GetDocumentationVersionsRequest": { "base": "Gets the documentation versions of an API.
", "refs": { } }, "GetDomainNameRequest": { "base": "Request to get the name of a DomainName resource.
", "refs": { } }, "GetDomainNamesRequest": { "base": "Request to describe a collection of DomainName resources.
", "refs": { } }, "GetExportRequest": { "base": "Request a new export of a RestApi for a particular Stage.
", "refs": { } }, "GetGatewayResponseRequest": { "base": "Gets a GatewayResponse of a specified response type on the given RestApi.
", "refs": { } }, "GetGatewayResponsesRequest": { "base": "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.
", "refs": { } }, "GetIntegrationRequest": { "base": "Represents a request to get the integration configuration.
", "refs": { } }, "GetIntegrationResponseRequest": { "base": "Represents a get integration response request.
", "refs": { } }, "GetMethodRequest": { "base": "Request to describe an existing Method resource.
", "refs": { } }, "GetMethodResponseRequest": { "base": "Request to describe a MethodResponse resource.
", "refs": { } }, "GetModelRequest": { "base": "Request to list information about a model in an existing RestApi resource.
", "refs": { } }, "GetModelTemplateRequest": { "base": "Request to generate a sample mapping template used to transform the payload.
", "refs": { } }, "GetModelsRequest": { "base": "Request to list existing Models defined for a RestApi resource.
", "refs": { } }, "GetRequestValidatorRequest": { "base": "Gets a RequestValidator of a given RestApi.
", "refs": { } }, "GetRequestValidatorsRequest": { "base": "Gets the RequestValidators collection of a given RestApi.
", "refs": { } }, "GetResourceRequest": { "base": "Request to list information about a resource.
", "refs": { } }, "GetResourcesRequest": { "base": "Request to list information about a collection of resources.
", "refs": { } }, "GetRestApiRequest": { "base": "The GET request to list an existing RestApi defined for your collection.
", "refs": { } }, "GetRestApisRequest": { "base": "The GET request to list existing RestApis defined for your collection.
", "refs": { } }, "GetSdkRequest": { "base": "Request a new generated client SDK for a RestApi and Stage.
", "refs": { } }, "GetSdkTypeRequest": { "base": "Get an SdkType instance.
", "refs": { } }, "GetSdkTypesRequest": { "base": "Get the SdkTypes collection.
", "refs": { } }, "GetStageRequest": { "base": "Requests API Gateway to get information about a Stage resource.
", "refs": { } }, "GetStagesRequest": { "base": "Requests API Gateway to get information about one or more Stage resources.
", "refs": { } }, "GetUsagePlanKeyRequest": { "base": "The GET request to get a usage plan key of a given key identifier.
", "refs": { } }, "GetUsagePlanKeysRequest": { "base": "The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
", "refs": { } }, "GetUsagePlanRequest": { "base": "The GET request to get a usage plan of a given plan identifier.
", "refs": { } }, "GetUsagePlansRequest": { "base": "The GET request to get all the usage plans of the caller's account.
", "refs": { } }, "GetUsageRequest": { "base": "The GET request to get the usage data of a usage plan in a specified time interval.
", "refs": { } }, "GetVpcLinkRequest": { "base": "Gets a specified VPC link under the caller's account in a region.
", "refs": { } }, "GetVpcLinksRequest": { "base": "Gets the VpcLinks collection under the caller's account in a selected region.
", "refs": { } }, "ImportApiKeysRequest": { "base": "The POST request to import API keys from an external source, such as a CSV-formatted file.
", "refs": { } }, "ImportDocumentationPartsRequest": { "base": "Import documentation parts from an external (e.g., Swagger) definition file.
", "refs": { } }, "ImportRestApiRequest": { "base": "A POST request to import an API to API Gateway using an input of an API definition file.
", "refs": { } }, "Integer": { "base": null, "refs": { "Integration$timeoutInMillis": "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
", "MethodSetting$throttlingBurstLimit": "Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.
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.
The maximum number of requests that can be made in a given time period.
", "QuotaSettings$offset": "The number of requests subtracted from the given limit in the initial time period.
", "TestInvokeAuthorizerResponse$clientStatus": "The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
", "TestInvokeMethodResponse$status": "The HTTP status code.
", "ThrottleSettings$burstLimit": "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.
" } }, "Integration": { "base": "Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
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.
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}The successful response returns a 200 OK status code and a payload similar to the following:
{ \"_links\": { \"curies\": [ { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"http://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\" } } }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.
", "refs": { "MapOfIntegrationResponse$value": null } }, "IntegrationType": { "base": "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.
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.
Specifies a put integration input's type.
" } }, "LimitExceededException": { "base": "The request exceeded the rate limit. Retry after the specified time period.
", "refs": { } }, "ListOfARNs": { "base": null, "refs": { "Authorizer$providerARNs": "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.
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.
The current page of elements from this collection.
" } }, "ListOfApiStage": { "base": null, "refs": { "CreateUsagePlanRequest$apiStages": "The associated API stages of the usage plan.
", "UsagePlan$apiStages": "The associated API stages of a usage plan.
" } }, "ListOfAuthorizer": { "base": null, "refs": { "Authorizers$items": "The current page of elements from this collection.
" } }, "ListOfBasePathMapping": { "base": null, "refs": { "BasePathMappings$items": "The current page of elements from this collection.
" } }, "ListOfClientCertificate": { "base": null, "refs": { "ClientCertificates$items": "The current page of elements from this collection.
" } }, "ListOfDeployment": { "base": null, "refs": { "Deployments$items": "The current page of elements from this collection.
" } }, "ListOfDocumentationPart": { "base": null, "refs": { "DocumentationParts$items": "The current page of elements from this collection.
" } }, "ListOfDocumentationVersion": { "base": null, "refs": { "DocumentationVersions$items": "The current page of elements from this collection.
" } }, "ListOfDomainName": { "base": null, "refs": { "DomainNames$items": "The current page of elements from this collection.
" } }, "ListOfEndpointType": { "base": null, "refs": { "EndpointConfiguration$types": "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.
Returns the entire collection, because of no pagination support.
" } }, "ListOfLong": { "base": null, "refs": { "ListOfUsage$member": null } }, "ListOfModel": { "base": null, "refs": { "Models$items": "The current page of elements from this collection.
" } }, "ListOfPatchOperation": { "base": "A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.", "refs": { "UpdateAccountRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateApiKeyRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateAuthorizerRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateBasePathMappingRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateClientCertificateRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateDeploymentRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateDocumentationPartRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateDocumentationVersionRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateDomainNameRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateGatewayResponseRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateIntegrationRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateIntegrationResponseRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateMethodRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateMethodResponseRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateModelRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateRequestValidatorRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateResourceRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateRestApiRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateStageRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateUsagePlanRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateUsageRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
", "UpdateVpcLinkRequest$patchOperations": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" } }, "ListOfRequestValidator": { "base": null, "refs": { "RequestValidators$items": "The current page of elements from this collection.
" } }, "ListOfResource": { "base": null, "refs": { "Resources$items": "The current page of elements from this collection.
" } }, "ListOfRestApi": { "base": null, "refs": { "RestApis$items": "The current page of elements from this collection.
" } }, "ListOfSdkConfigurationProperty": { "base": null, "refs": { "SdkType$configurationProperties": "A list of configuration properties of an SdkType.
" } }, "ListOfSdkType": { "base": null, "refs": { "SdkTypes$items": "The current page of elements from this collection.
" } }, "ListOfStage": { "base": null, "refs": { "Stages$item": "The current page of elements from this collection.
" } }, "ListOfStageKeys": { "base": null, "refs": { "CreateApiKeyRequest$stageKeys": "DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
" } }, "ListOfString": { "base": null, "refs": { "Account$features": "A list of features supported for the account. When usage plans are enabled, the features list will include an entry of \"UsagePlans\".
A list of Stage resources that are associated with the ApiKey resource.
", "ApiKeyIds$ids": "A list of all the ApiKey identifiers.
", "ApiKeyIds$warnings": "A list of warning messages.
", "ApiKeys$warnings": "A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
", "CreateVpcLinkRequest$targetArns": "[Required] The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
", "DocumentationPartIds$ids": "A list of the returned documentation part identifiers.
", "DocumentationPartIds$warnings": "A list of warning messages reported during import of documentation parts.
", "GetDeploymentRequest$embed": "A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the \"apisummary\" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\" string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods.
A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.
Specifies the integration's cache key parameters.
", "MapOfStringToList$value": null, "PutIntegrationRequest$cacheKeyParameters": "Specifies a put integration input's cache key parameters.
", "RestApi$warnings": "The warning messages reported when failonwarnings is turned on during API import.
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
", "VpcLink$targetArns": "The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
" } }, "ListOfUsage": { "base": null, "refs": { "MapOfKeyUsages$value": null } }, "ListOfUsagePlan": { "base": null, "refs": { "UsagePlans$items": "The current page of elements from this collection.
" } }, "ListOfUsagePlanKey": { "base": null, "refs": { "UsagePlanKeys$items": "The current page of elements from this collection.
" } }, "ListOfVpcLink": { "base": null, "refs": { "VpcLinks$items": "The current page of elements from this collection.
" } }, "LocationStatusType": { "base": null, "refs": { "GetDocumentationPartsRequest$locationStatus": "The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
The execution latency of the test authorizer request.
", "TestInvokeMethodResponse$latency": "The execution latency of the test invoke request.
" } }, "MapOfHeaderValues": { "base": null, "refs": { "TestInvokeAuthorizerRequest$headers": "[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.
", "TestInvokeMethodRequest$headers": "A key-value map of headers to simulate an incoming invocation request.
", "TestInvokeMethodResponse$headers": "The headers of the HTTP response.
" } }, "MapOfIntegrationResponse": { "base": null, "refs": { "Integration$integrationResponses": "Specifies the integration's responses.
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} The successful response returns 200 OK status and a payload as follows:
{ \"_links\": { \"curies\": { \"href\": \"http://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\" }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].
Gets an API resource's method of a given HTTP verb.
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.
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}{ \"_links\": { \"curies\": [ { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"http://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.
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.
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}The successful response returns a 200 OK status code and a payload similar to the following:
{ \"_links\": { \"curies\": { \"href\": \"http://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\" }A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\\*/\\* for overriding all methods in the stage.
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.
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.)
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.
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.)
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.
", "CreateDeploymentRequest$variables": "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-._~:/?#&=,]+.
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-._~:/?#&=,]+.
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.
", "GatewayResponse$responseParameters": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
", "GatewayResponse$responseTemplates": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
", "GetExportRequest$parameters": "A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType swagger, any combination of the following parameters are supported: integrations will export the API with x-amazon-apigateway-integration extensions. authorizers will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool
A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.
A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.
To exclude DocumentationParts from the import, set parameters as ignore=documentation.
To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE orendpointConfigurationTypes=REGIONAL. The default endpoint type is EDGE.
To handle imported basePath, set parameters as basePath=ignore, basePath=prepend or basePath=split.
For example, the AWS CLI command to exclude documentation from the imported API is:
aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.jsonThe AWS CLI command to set the regional endpoint on the imported API is:
aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.jsonA 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.
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.
", "IntegrationResponse$responseParameters": "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.
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.
", "Method$requestModels": "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).
", "MethodResponse$responseModels": "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.
", "PutGatewayResponseRequest$responseParameters": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
", "PutGatewayResponseRequest$responseTemplates": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
", "PutIntegrationRequest$requestParameters": "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.
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.
", "PutIntegrationResponseRequest$responseParameters": "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.
Specifies a put integration response's templates.
", "PutMethodRequest$requestModels": "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.
", "PutMethodResponseRequest$responseModels": "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.
", "PutRestApiRequest$parameters": "Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json.
A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
A key-value map of stage variables to simulate an invocation on a deployed Stage.
", "TestInvokeAuthorizerRequest$additionalContext": "[Optional] A key-value map of additional context variables.
", "TestInvokeAuthorizerResponse$claims": "The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
", "TestInvokeMethodRequest$stageVariables": "A key-value map of stage variables to simulate an invocation on a deployed Stage.
" } }, "Method": { "base": "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.
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}The successful response returns a 200 OK status code and a payload similar to the following:
{ \"_links\": { \"curies\": [ { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"http://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.
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.
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}The successful response returns 200 OK status and a payload as follows:
{ \"_links\": { \"curies\": { \"href\": \"http://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\" }Specifies the method setting properties.
", "refs": { "MapOfMethodSettings$value": null } }, "MethodSnapshot": { "base": "Represents a summary of a Method resource, given a particular date and time.
", "refs": { "MapOfMethodSnapshot$value": null } }, "Model": { "base": "Represents the data structure of a method's request or response payload.
A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.
A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.
Represents a collection of Model resources.
", "refs": { } }, "NotFoundException": { "base": "The requested resource is not found. Make sure that the request URI is correct.
", "refs": { } }, "NullableBoolean": { "base": null, "refs": { "CreateDeploymentRequest$cacheClusterEnabled": "Enables a cache cluster for the Stage resource specified in the input.
", "GetApiKeyRequest$includeValue": "A boolean flag to specify whether (true) or not (false) the result contains the key value.
A boolean flag to specify whether (true) or not (false) the result contains key values.
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
" } }, "NullableInteger": { "base": null, "refs": { "Authorizer$authorizerResultTtlInSeconds": "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.
", "CreateAuthorizerRequest$authorizerResultTtlInSeconds": "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.
", "GetApiKeysRequest$limit": "The maximum number of returned results per page.
", "GetAuthorizersRequest$limit": "The maximum number of returned results per page.
", "GetBasePathMappingsRequest$limit": "The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.
", "GetClientCertificatesRequest$limit": "The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.
", "GetDeploymentsRequest$limit": "The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.
", "GetDocumentationPartsRequest$limit": "The maximum number of returned results per page.
", "GetDocumentationVersionsRequest$limit": "The maximum number of returned results per page.
", "GetDomainNamesRequest$limit": "The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.
", "GetGatewayResponsesRequest$limit": "The maximum number of returned results per page. The GatewayResponses collection does not support pagination and the limit does not apply here.
", "GetModelsRequest$limit": "The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.
", "GetRequestValidatorsRequest$limit": "The maximum number of returned results per page.
", "GetResourcesRequest$limit": "The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.
", "GetRestApisRequest$limit": "The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.
", "GetSdkTypesRequest$limit": "The maximum number of returned results per page.
", "GetUsagePlanKeysRequest$limit": "The maximum number of returned results per page.
", "GetUsagePlansRequest$limit": "The maximum number of returned results per page.
", "GetUsageRequest$limit": "The maximum number of returned results per page.
", "GetVpcLinksRequest$limit": "The maximum number of returned results per page.
", "PutIntegrationRequest$timeoutInMillis": "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
" } }, "Op": { "base": null, "refs": { "PatchOperation$op": " 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.
A summary of the RestApi at the date and time that the deployment resource was created.
" } }, "ProviderARN": { "base": null, "refs": { "ListOfARNs$member": null } }, "PutGatewayResponseRequest": { "base": "Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
", "refs": { } }, "PutIntegrationRequest": { "base": "Sets up a method's integration.
", "refs": { } }, "PutIntegrationResponseRequest": { "base": "Represents a put integration response request.
", "refs": { } }, "PutMethodRequest": { "base": "Request to add a method to an existing Resource resource.
", "refs": { } }, "PutMethodResponseRequest": { "base": "Request to add a MethodResponse to an existing Method resource.
", "refs": { } }, "PutMode": { "base": null, "refs": { "ImportDocumentationPartsRequest$mode": "A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.
The mode query parameter to specify the update mode. Valid values are \"merge\" and \"overwrite\". By default, the update mode is \"merge\".
A PUT request to update an existing API, with external API definitions specified as the request body.
", "refs": { } }, "QuotaPeriodType": { "base": null, "refs": { "QuotaSettings$period": "The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\".
" } }, "QuotaSettings": { "base": "Quotas configured for a usage plan.
", "refs": { "CreateUsagePlanRequest$quota": "The quota of the usage plan.
", "UsagePlan$quota": "The maximum number of permitted requests per a given unit time interval.
" } }, "RequestValidator": { "base": "A set of validation rules for incoming Method requests.
In Swagger, 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.
A collection of RequestValidator resources of a given RestApi.
In Swagger, the RequestValidators of an API is defined by the x-amazon-apigateway-request-validators extension.
Represents an API resource.
", "refs": { "ListOfResource$member": null } }, "Resources": { "base": "Represents a collection of Resource resources.
", "refs": { } }, "RestApi": { "base": "Represents a REST API.
", "refs": { "ListOfRestApi$member": null } }, "RestApis": { "base": "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.
", "refs": { } }, "SdkConfigurationProperty": { "base": "A configuration property of an SDK type.
", "refs": { "ListOfSdkConfigurationProperty$member": null } }, "SdkResponse": { "base": "The binary blob response to GetSdk, which contains the generated SDK.
", "refs": { } }, "SdkType": { "base": "A type of SDK that API Gateway can generate.
", "refs": { "ListOfSdkType$member": null } }, "SdkTypes": { "base": "The collection of SdkType instances.
", "refs": { } }, "ServiceUnavailableException": { "base": "The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
", "refs": { } }, "Stage": { "base": "Represents a unique identifier for a version of a deployed RestApi that is callable by users.
", "refs": { "ListOfStage$member": null } }, "StageKey": { "base": "A reference to a unique stage identified in the format {restApiId}/{stage}.
A list of Stage resources that are associated with the ApiKey resource.
", "refs": { } }, "StatusCode": { "base": "The status code.
", "refs": { "DeleteIntegrationResponseRequest$statusCode": "Specifies a delete integration response request's status code.
", "DeleteMethodResponseRequest$statusCode": "The status code identifier for the MethodResponse resource.
", "GatewayResponse$statusCode": "The HTTP status code for this GatewayResponse.
", "GetIntegrationResponseRequest$statusCode": "Specifies a get integration response request's status code.
", "GetMethodResponseRequest$statusCode": "The status code for the MethodResponse resource.
", "IntegrationResponse$statusCode": "Specifies the status code that is used to map the integration response to an existing MethodResponse.
", "MethodResponse$statusCode": "The method response's status code.
", "PutGatewayResponseRequest$statusCode": "The HTTP status code of the GatewayResponse.", "PutIntegrationResponseRequest$statusCode": "Specifies the status code that is used to map the integration response to an existing MethodResponse.
", "PutMethodResponseRequest$statusCode": "The method response's status code.
", "UpdateIntegrationResponseRequest$statusCode": "Specifies an update integration response request's status code.
", "UpdateMethodResponseRequest$statusCode": "The status code for the MethodResponse resource.
" } }, "String": { "base": null, "refs": { "AccessLogSettings$format": "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
The ARN of the CloudWatch Logs log group to receive access logs.
", "Account$cloudwatchRoleArn": "The ARN of an Amazon CloudWatch role for the current Account.
", "Account$apiKeyVersion": "The version of the API keys used for the account.
", "ApiKey$id": "The identifier of the API Key.
", "ApiKey$value": "The value of the API Key.
", "ApiKey$name": "The name of the API Key.
", "ApiKey$customerId": "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
", "ApiKey$description": "The description of the API Key.
", "ApiKeys$position": null, "ApiStage$apiId": "API Id of the associated API stage in a usage plan.
", "ApiStage$stage": "API stage name of the associated API stage in a usage plan.
", "Authorizer$id": "The identifier for the authorizer resource.
", "Authorizer$name": "[Required] The name of the authorizer.
", "Authorizer$authType": "Optional customer-defined field, used in Swagger imports and exports without functional impact.
", "Authorizer$authorizerUri": "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.
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.
", "Authorizer$identitySource": "The identity source for which authorization is requested.
TOKEN 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.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.COGNITO_USER_POOLS authorizer, this property is not used.A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function 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.
The base path name that callers of the API must provide as part of the URL after the domain name.
", "BasePathMapping$restApiId": "The string identifier of the associated RestApi.
", "BasePathMapping$stage": "The name of the associated stage.
", "BasePathMappings$position": null, "CanarySettings$deploymentId": "The ID of the canary deployment.
", "ClientCertificate$clientCertificateId": "The identifier of the client certificate.
", "ClientCertificate$description": "The description of the client certificate.
", "ClientCertificate$pemEncodedCertificate": "The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
", "ClientCertificates$position": null, "ConflictException$message": null, "CreateApiKeyRequest$name": "The name of the ApiKey.
", "CreateApiKeyRequest$description": "The description of the ApiKey.
", "CreateApiKeyRequest$value": "Specifies a value of the API key.
", "CreateApiKeyRequest$customerId": "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
", "CreateAuthorizerRequest$restApiId": "The string identifier of the associated RestApi.
", "CreateAuthorizerRequest$name": "[Required] The name of the authorizer.
", "CreateAuthorizerRequest$authType": "Optional customer-defined field, used in Swagger imports and exports without functional impact.
", "CreateAuthorizerRequest$authorizerUri": "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.
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.
", "CreateAuthorizerRequest$identitySource": "The identity source for which authorization is requested.
TOKEN 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.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.COGNITO_USER_POOLS authorizer, this property is not used.A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function 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.
The domain name of the BasePathMapping resource to create.
", "CreateBasePathMappingRequest$basePath": "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. Leave this blank if you do not want callers to specify a base path name after the domain name.
", "CreateBasePathMappingRequest$restApiId": "The string identifier of the associated RestApi.
", "CreateBasePathMappingRequest$stage": "The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.
", "CreateDeploymentRequest$restApiId": "The string identifier of the associated RestApi.
", "CreateDeploymentRequest$stageName": "The name of the Stage resource for the Deployment resource to create.
", "CreateDeploymentRequest$stageDescription": "The description of the Stage resource for the Deployment resource to create.
", "CreateDeploymentRequest$description": "The description for the Deployment resource to create.
", "CreateDocumentationPartRequest$restApiId": "[Required] The string identifier of the associated RestApi.
", "CreateDocumentationPartRequest$properties": "[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only Swagger-compliant key-value pairs can be exported and, hence, published.
", "CreateDocumentationVersionRequest$restApiId": "[Required] The string identifier of the associated RestApi.
", "CreateDocumentationVersionRequest$documentationVersion": "[Required] The version identifier of the new snapshot.
", "CreateDocumentationVersionRequest$stageName": "The stage name to be associated with the new documentation snapshot.
", "CreateDocumentationVersionRequest$description": "A description about the new documentation snapshot.
", "CreateDomainNameRequest$domainName": "(Required) The name of the DomainName resource.
", "CreateDomainNameRequest$certificateName": "The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
", "CreateDomainNameRequest$certificateBody": "[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
", "CreateDomainNameRequest$certificatePrivateKey": "[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
", "CreateDomainNameRequest$certificateChain": "[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.
", "CreateDomainNameRequest$certificateArn": "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.
", "CreateDomainNameRequest$regionalCertificateName": "The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
", "CreateDomainNameRequest$regionalCertificateArn": "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.
", "CreateModelRequest$restApiId": "The RestApi identifier under which the Model will be created.
", "CreateModelRequest$name": "The name of the model. Must be alphanumeric.
", "CreateModelRequest$description": "The description of the model.
", "CreateModelRequest$schema": "The schema for the model. For application/json models, this should be JSON-schema draft v4 model.
The content-type for the model.
", "CreateRequestValidatorRequest$restApiId": "The string identifier of the associated RestApi.
", "CreateRequestValidatorRequest$name": "The name of the to-be-created RequestValidator.
", "CreateResourceRequest$restApiId": "The string identifier of the associated RestApi.
", "CreateResourceRequest$parentId": "The parent resource's identifier.
", "CreateResourceRequest$pathPart": "The last path segment for this resource.
", "CreateRestApiRequest$name": "The name of the RestApi.
", "CreateRestApiRequest$description": "The description of the RestApi.
", "CreateRestApiRequest$version": "A version identifier for the API.
", "CreateRestApiRequest$cloneFrom": "The ID of the RestApi that you want to clone from.
", "CreateStageRequest$restApiId": "The string identifier of the associated RestApi.
", "CreateStageRequest$stageName": "[Required] The name for the Stage resource.
", "CreateStageRequest$deploymentId": "[Required] The identifier of the Deployment resource for the Stage resource.
", "CreateStageRequest$description": "The description of the Stage resource.
", "CreateStageRequest$documentationVersion": "The version of the associated API documentation.
", "CreateUsagePlanKeyRequest$usagePlanId": "The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.
", "CreateUsagePlanKeyRequest$keyId": "The identifier of a UsagePlanKey resource for a plan customer.
", "CreateUsagePlanKeyRequest$keyType": "The type of a UsagePlanKey resource for a plan customer.
", "CreateUsagePlanRequest$name": "The name of the usage plan.
", "CreateUsagePlanRequest$description": "The description of the usage plan.
", "CreateVpcLinkRequest$name": "[Required] The name used to label and identify the VPC link.
", "CreateVpcLinkRequest$description": "The description of the VPC link.
", "DeleteApiKeyRequest$apiKey": "The identifier of the ApiKey resource to be deleted.
", "DeleteAuthorizerRequest$restApiId": "The string identifier of the associated RestApi.
", "DeleteAuthorizerRequest$authorizerId": "The identifier of the Authorizer resource.
", "DeleteBasePathMappingRequest$domainName": "The domain name of the BasePathMapping resource to delete.
", "DeleteBasePathMappingRequest$basePath": "The base path name of the BasePathMapping resource to delete.
", "DeleteClientCertificateRequest$clientCertificateId": "The identifier of the ClientCertificate resource to be deleted.
", "DeleteDeploymentRequest$restApiId": "The string identifier of the associated RestApi.
", "DeleteDeploymentRequest$deploymentId": "The identifier of the Deployment resource to delete.
", "DeleteDocumentationPartRequest$restApiId": "[Required] The string identifier of the associated RestApi.
", "DeleteDocumentationPartRequest$documentationPartId": "[Required] The identifier of the to-be-deleted documentation part.
", "DeleteDocumentationVersionRequest$restApiId": "[Required] The string identifier of the associated RestApi.
", "DeleteDocumentationVersionRequest$documentationVersion": "[Required] The version identifier of a to-be-deleted documentation snapshot.
", "DeleteDomainNameRequest$domainName": "The name of the DomainName resource to be deleted.
", "DeleteGatewayResponseRequest$restApiId": "The string identifier of the associated RestApi.
", "DeleteIntegrationRequest$restApiId": "The string identifier of the associated RestApi.
", "DeleteIntegrationRequest$resourceId": "Specifies a delete integration request's resource identifier.
", "DeleteIntegrationRequest$httpMethod": "Specifies a delete integration request's HTTP method.
", "DeleteIntegrationResponseRequest$restApiId": "The string identifier of the associated RestApi.
", "DeleteIntegrationResponseRequest$resourceId": "Specifies a delete integration response request's resource identifier.
", "DeleteIntegrationResponseRequest$httpMethod": "Specifies a delete integration response request's HTTP method.
", "DeleteMethodRequest$restApiId": "The string identifier of the associated RestApi.
", "DeleteMethodRequest$resourceId": "The Resource identifier for the Method resource.
", "DeleteMethodRequest$httpMethod": "The HTTP verb of the Method resource.
", "DeleteMethodResponseRequest$restApiId": "The string identifier of the associated RestApi.
", "DeleteMethodResponseRequest$resourceId": "The Resource identifier for the MethodResponse resource.
", "DeleteMethodResponseRequest$httpMethod": "The HTTP verb of the Method resource.
", "DeleteModelRequest$restApiId": "The string identifier of the associated RestApi.
", "DeleteModelRequest$modelName": "The name of the model to delete.
", "DeleteRequestValidatorRequest$restApiId": "The string identifier of the associated RestApi.
", "DeleteRequestValidatorRequest$requestValidatorId": "[Required] The identifier of the RequestValidator to be deleted.
", "DeleteResourceRequest$restApiId": "The string identifier of the associated RestApi.
", "DeleteResourceRequest$resourceId": "The identifier of the Resource resource.
", "DeleteRestApiRequest$restApiId": "The string identifier of the associated RestApi.
", "DeleteStageRequest$restApiId": "The string identifier of the associated RestApi.
", "DeleteStageRequest$stageName": "The name of the Stage resource to delete.
", "DeleteUsagePlanKeyRequest$usagePlanId": "The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
", "DeleteUsagePlanKeyRequest$keyId": "The Id of the UsagePlanKey resource to be deleted.
", "DeleteUsagePlanRequest$usagePlanId": "The Id of the to-be-deleted usage plan.
", "DeleteVpcLinkRequest$vpcLinkId": "[Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", "Deployment$id": "The identifier for the deployment resource.
", "Deployment$description": "The description for the deployment resource.
", "Deployments$position": null, "DocumentationPart$id": "The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., \"{ \\\"description\\\": \\\"The API does ...\\\" }\". Only Swagger-compliant documentation-related fields from the x-amazon-apigateway-documentation.
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.
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.
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.
The version identifier of the API documentation snapshot.
", "DocumentationVersion$description": "The description of the API documentation snapshot.
", "DocumentationVersions$position": null, "DomainName$domainName": "The name of the DomainName resource.
", "DomainName$certificateName": "The name of the certificate that will be used by edge-optimized endpoint for this domain name.
", "DomainName$certificateArn": "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.
", "DomainName$regionalDomainName": "The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
", "DomainName$regionalHostedZoneId": "The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
", "DomainName$regionalCertificateName": "The name of the certificate that will be used for validating the regional domain name.
", "DomainName$regionalCertificateArn": "The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
", "DomainName$distributionDomainName": "The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
", "DomainName$distributionHostedZoneId": "The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.
", "ExportResponse$contentDisposition": "The content-disposition header value in the HTTP response.
", "FlushStageAuthorizersCacheRequest$restApiId": "The string identifier of the associated RestApi.
", "FlushStageAuthorizersCacheRequest$stageName": "The name of the stage to flush.
", "FlushStageCacheRequest$restApiId": "The string identifier of the associated RestApi.
", "FlushStageCacheRequest$stageName": "The name of the stage to flush its cache.
", "GatewayResponses$position": null, "GenerateClientCertificateRequest$description": "The description of the ClientCertificate.
", "GetApiKeyRequest$apiKey": "The identifier of the ApiKey resource.
", "GetApiKeysRequest$position": "The current pagination position in the paged result set.
", "GetApiKeysRequest$nameQuery": "The name of queried API keys.
", "GetApiKeysRequest$customerId": "The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.
", "GetAuthorizerRequest$restApiId": "The string identifier of the associated RestApi.
", "GetAuthorizerRequest$authorizerId": "The identifier of the Authorizer resource.
", "GetAuthorizersRequest$restApiId": "The string identifier of the associated RestApi.
", "GetAuthorizersRequest$position": "The current pagination position in the paged result set.
", "GetBasePathMappingRequest$domainName": "The domain name of the BasePathMapping resource to be described.
", "GetBasePathMappingRequest$basePath": "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. Leave this blank if you do not want callers to specify any base path name after the domain name.
", "GetBasePathMappingsRequest$domainName": "The domain name of a BasePathMapping resource.
", "GetBasePathMappingsRequest$position": "The current pagination position in the paged result set.
", "GetClientCertificateRequest$clientCertificateId": "The identifier of the ClientCertificate resource to be described.
", "GetClientCertificatesRequest$position": "The current pagination position in the paged result set.
", "GetDeploymentRequest$restApiId": "The string identifier of the associated RestApi.
", "GetDeploymentRequest$deploymentId": "The identifier of the Deployment resource to get information about.
", "GetDeploymentsRequest$restApiId": "The string identifier of the associated RestApi.
", "GetDeploymentsRequest$position": "The current pagination position in the paged result set.
", "GetDocumentationPartRequest$restApiId": "[Required] The string identifier of the associated RestApi.
", "GetDocumentationPartRequest$documentationPartId": "[Required] The string identifier of the associated RestApi.
", "GetDocumentationPartsRequest$restApiId": "[Required] The string identifier of the associated RestApi.
", "GetDocumentationPartsRequest$nameQuery": "The name of API entities of the to-be-retrieved documentation parts.
", "GetDocumentationPartsRequest$path": "The path of API entities of the to-be-retrieved documentation parts.
", "GetDocumentationPartsRequest$position": "The current pagination position in the paged result set.
", "GetDocumentationVersionRequest$restApiId": "[Required] The string identifier of the associated RestApi.
", "GetDocumentationVersionRequest$documentationVersion": "[Required] The version identifier of the to-be-retrieved documentation snapshot.
", "GetDocumentationVersionsRequest$restApiId": "[Required] The string identifier of the associated RestApi.
", "GetDocumentationVersionsRequest$position": "The current pagination position in the paged result set.
", "GetDomainNameRequest$domainName": "The name of the DomainName resource.
", "GetDomainNamesRequest$position": "The current pagination position in the paged result set.
", "GetExportRequest$restApiId": "The string identifier of the associated RestApi.
", "GetExportRequest$stageName": "The name of the Stage that will be exported.
", "GetExportRequest$exportType": "The type of export. Currently only 'swagger' is supported.
", "GetExportRequest$accepts": "The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType of swagger. This should be specified in the Accept header for direct API requests.
The string identifier of the associated RestApi.
", "GetGatewayResponsesRequest$restApiId": "The string identifier of the associated RestApi.
", "GetGatewayResponsesRequest$position": "The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
", "GetIntegrationRequest$restApiId": "The string identifier of the associated RestApi.
", "GetIntegrationRequest$resourceId": "Specifies a get integration request's resource identifier
", "GetIntegrationRequest$httpMethod": "Specifies a get integration request's HTTP method.
", "GetIntegrationResponseRequest$restApiId": "The string identifier of the associated RestApi.
", "GetIntegrationResponseRequest$resourceId": "Specifies a get integration response request's resource identifier.
", "GetIntegrationResponseRequest$httpMethod": "Specifies a get integration response request's HTTP method.
", "GetMethodRequest$restApiId": "The string identifier of the associated RestApi.
", "GetMethodRequest$resourceId": "The Resource identifier for the Method resource.
", "GetMethodRequest$httpMethod": "Specifies the method request's HTTP method type.
", "GetMethodResponseRequest$restApiId": "The string identifier of the associated RestApi.
", "GetMethodResponseRequest$resourceId": "The Resource identifier for the MethodResponse resource.
", "GetMethodResponseRequest$httpMethod": "The HTTP verb of the Method resource.
", "GetModelRequest$restApiId": "The RestApi identifier under which the Model exists.
", "GetModelRequest$modelName": "The name of the model as an identifier.
", "GetModelTemplateRequest$restApiId": "The string identifier of the associated RestApi.
", "GetModelTemplateRequest$modelName": "The name of the model for which to generate a template.
", "GetModelsRequest$restApiId": "The string identifier of the associated RestApi.
", "GetModelsRequest$position": "The current pagination position in the paged result set.
", "GetRequestValidatorRequest$restApiId": "The string identifier of the associated RestApi.
", "GetRequestValidatorRequest$requestValidatorId": "[Required] The identifier of the RequestValidator to be retrieved.
", "GetRequestValidatorsRequest$restApiId": "The string identifier of the associated RestApi.
", "GetRequestValidatorsRequest$position": "The current pagination position in the paged result set.
", "GetResourceRequest$restApiId": "The string identifier of the associated RestApi.
", "GetResourceRequest$resourceId": "The identifier for the Resource resource.
", "GetResourcesRequest$restApiId": "The string identifier of the associated RestApi.
", "GetResourcesRequest$position": "The current pagination position in the paged result set.
", "GetRestApiRequest$restApiId": "The identifier of the RestApi resource.
", "GetRestApisRequest$position": "The current pagination position in the paged result set.
", "GetSdkRequest$restApiId": "The string identifier of the associated RestApi.
", "GetSdkRequest$stageName": "The name of the Stage that the SDK will use.
", "GetSdkRequest$sdkType": "The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
The identifier of the queried SdkType instance.
", "GetSdkTypesRequest$position": "The current pagination position in the paged result set.
", "GetStageRequest$restApiId": "The string identifier of the associated RestApi.
", "GetStageRequest$stageName": "The name of the Stage resource to get information about.
", "GetStagesRequest$restApiId": "The string identifier of the associated RestApi.
", "GetStagesRequest$deploymentId": "The stages' deployment identifiers.
", "GetUsagePlanKeyRequest$usagePlanId": "The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
", "GetUsagePlanKeyRequest$keyId": "The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.
", "GetUsagePlanKeysRequest$usagePlanId": "The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
", "GetUsagePlanKeysRequest$position": "The current pagination position in the paged result set.
", "GetUsagePlanKeysRequest$nameQuery": "A query parameter specifying the name of the to-be-returned usage plan keys.
", "GetUsagePlanRequest$usagePlanId": "The identifier of the UsagePlan resource to be retrieved.
", "GetUsagePlansRequest$position": "The current pagination position in the paged result set.
", "GetUsagePlansRequest$keyId": "The identifier of the API key associated with the usage plans.
", "GetUsageRequest$usagePlanId": "The Id of the usage plan associated with the usage data.
", "GetUsageRequest$keyId": "The Id of the API key associated with the resultant usage data.
", "GetUsageRequest$startDate": "The starting date (e.g., 2016-01-01) of the usage data.
", "GetUsageRequest$endDate": "The ending date (e.g., 2016-12-31) of the usage data.
", "GetUsageRequest$position": "The current pagination position in the paged result set.
", "GetVpcLinkRequest$vpcLinkId": "[Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", "GetVpcLinksRequest$position": "The current pagination position in the paged result set.
", "ImportDocumentationPartsRequest$restApiId": "[Required] The string identifier of the associated RestApi.
", "Integration$httpMethod": "Specifies the integration's HTTP method type.
", "Integration$uri": "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}
The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
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.
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. Specifies the integration's cache namespace.
", "IntegrationResponse$selectionPattern": "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.
The method's HTTP verb.
", "Method$authorizationType": "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.
The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.
The identifier of a RequestValidator for request validation.
", "Method$operationName": "A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.
Specifies the logging level for this method, which effects 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.
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.
The identifier for the model resource.
", "Model$name": "The name of the model. Must be an alphanumeric string.
", "Model$description": "The description of the model.
", "Model$schema": "The schema for the model. For application/json models, this should be JSON-schema draft v4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
The content-type for the model.
", "Models$position": null, "NotFoundException$message": null, "PatchOperation$path": "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.
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.
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\".
The string identifier of the associated RestApi.
", "PutIntegrationRequest$restApiId": "The string identifier of the associated RestApi.
", "PutIntegrationRequest$resourceId": "Specifies a put integration request's resource ID.
", "PutIntegrationRequest$httpMethod": "Specifies a put integration request's HTTP method.
", "PutIntegrationRequest$integrationHttpMethod": "Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
", "PutIntegrationRequest$uri": "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}
The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
Specifies whether credentials are required for a put integration.
", "PutIntegrationRequest$passthroughBehavior": "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.
Specifies a put integration input's cache namespace.
", "PutIntegrationResponseRequest$restApiId": "The string identifier of the associated RestApi.
", "PutIntegrationResponseRequest$resourceId": "Specifies a put integration response request's resource identifier.
", "PutIntegrationResponseRequest$httpMethod": "Specifies a put integration response request's HTTP method.
", "PutIntegrationResponseRequest$selectionPattern": "Specifies the selection pattern of a put integration response.
", "PutMethodRequest$restApiId": "The string identifier of the associated RestApi.
", "PutMethodRequest$resourceId": "The Resource identifier for the new Method resource.
", "PutMethodRequest$httpMethod": "Specifies the method request's HTTP method type.
", "PutMethodRequest$authorizationType": "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.
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
", "PutMethodRequest$operationName": "A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.
The identifier of a RequestValidator for validating the method request.
", "PutMethodResponseRequest$restApiId": "The string identifier of the associated RestApi.
", "PutMethodResponseRequest$resourceId": "The Resource identifier for the Method resource.
", "PutMethodResponseRequest$httpMethod": "The HTTP verb of the Method resource.
", "PutRestApiRequest$restApiId": "The string identifier of the associated RestApi.
", "RequestValidator$id": "The identifier of this RequestValidator.
", "RequestValidator$name": "The name of this RequestValidator
", "RequestValidators$position": null, "Resource$id": "The resource's identifier.
", "Resource$parentId": "The parent resource's identifier.
", "Resource$pathPart": "The last path segment for this resource.
", "Resource$path": "The full path for this resource.
", "Resources$position": null, "RestApi$id": "The API's identifier. This identifier is unique across all of your APIs in API Gateway.
", "RestApi$name": "The API's name.
", "RestApi$description": "The API's description.
", "RestApi$version": "A version identifier for the API.
", "RestApis$position": null, "SdkConfigurationProperty$name": "The name of a an SdkType configuration property.
", "SdkConfigurationProperty$friendlyName": "The user-friendly name of an SdkType configuration property.
", "SdkConfigurationProperty$description": "The description of an SdkType configuration property.
", "SdkConfigurationProperty$defaultValue": "The default value of an SdkType configuration property.
", "SdkResponse$contentType": "The content-type header value in the HTTP response.
", "SdkResponse$contentDisposition": "The content-disposition header value in the HTTP response.
", "SdkType$id": "The identifier of an SdkType instance.
", "SdkType$friendlyName": "The user-friendly name of an SdkType instance.
", "SdkType$description": "The description of an SdkType.
", "SdkTypes$position": null, "ServiceUnavailableException$retryAfterSeconds": null, "ServiceUnavailableException$message": null, "Stage$deploymentId": "The identifier of the Deployment that the stage points to.
", "Stage$clientCertificateId": "The identifier of a client certificate for an API stage.
", "Stage$stageName": "The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
", "Stage$description": "The stage's description.
", "Stage$documentationVersion": "The version of the associated API documentation.
", "StageKey$restApiId": "The string identifier of the associated RestApi.
", "StageKey$stageName": "The stage name associated with the stage key.
", "Template$value": "The Apache Velocity Template Language (VTL) template content used for the template resource.
", "TestInvokeAuthorizerRequest$restApiId": "The string identifier of the associated RestApi.
", "TestInvokeAuthorizerRequest$authorizerId": "Specifies a test invoke authorizer request's Authorizer ID.
", "TestInvokeAuthorizerRequest$pathWithQueryString": "[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
", "TestInvokeAuthorizerRequest$body": "[Optional] The simulated request body of an incoming invocation request.
", "TestInvokeAuthorizerResponse$log": "The API Gateway execution log for the test authorizer request.
", "TestInvokeAuthorizerResponse$principalId": "The principal identity returned by the Authorizer
", "TestInvokeAuthorizerResponse$policy": "The JSON policy document returned by the Authorizer
", "TestInvokeMethodRequest$restApiId": "The string identifier of the associated RestApi.
", "TestInvokeMethodRequest$resourceId": "Specifies a test invoke method request's resource ID.
", "TestInvokeMethodRequest$httpMethod": "Specifies a test invoke method request's HTTP method.
", "TestInvokeMethodRequest$pathWithQueryString": "The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
", "TestInvokeMethodRequest$body": "The simulated request body of an incoming invocation request.
", "TestInvokeMethodRequest$clientCertificateId": "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.
", "TestInvokeMethodResponse$body": "The body of the HTTP response.
", "TestInvokeMethodResponse$log": "The API Gateway execution log for the test invoke request.
", "TooManyRequestsException$retryAfterSeconds": null, "TooManyRequestsException$message": null, "UnauthorizedException$message": null, "UpdateApiKeyRequest$apiKey": "The identifier of the ApiKey resource to be updated.
", "UpdateAuthorizerRequest$restApiId": "The string identifier of the associated RestApi.
", "UpdateAuthorizerRequest$authorizerId": "The identifier of the Authorizer resource.
", "UpdateBasePathMappingRequest$domainName": "The domain name of the BasePathMapping resource to change.
", "UpdateBasePathMappingRequest$basePath": "The base path of the BasePathMapping resource to change.
", "UpdateClientCertificateRequest$clientCertificateId": "The identifier of the ClientCertificate resource to be updated.
", "UpdateDeploymentRequest$restApiId": "The string identifier of the associated RestApi.
", "UpdateDeploymentRequest$deploymentId": "The replacement identifier for the Deployment resource to change information about.
", "UpdateDocumentationPartRequest$restApiId": "[Required] The string identifier of the associated RestApi.
", "UpdateDocumentationPartRequest$documentationPartId": "[Required] The identifier of the to-be-updated documentation part.
", "UpdateDocumentationVersionRequest$restApiId": "[Required] The string identifier of the associated RestApi..
", "UpdateDocumentationVersionRequest$documentationVersion": "[Required] The version identifier of the to-be-updated documentation version.
", "UpdateDomainNameRequest$domainName": "The name of the DomainName resource to be changed.
", "UpdateGatewayResponseRequest$restApiId": "The string identifier of the associated RestApi.
", "UpdateIntegrationRequest$restApiId": "The string identifier of the associated RestApi.
", "UpdateIntegrationRequest$resourceId": "Represents an update integration request's resource identifier.
", "UpdateIntegrationRequest$httpMethod": "Represents an update integration request's HTTP method.
", "UpdateIntegrationResponseRequest$restApiId": "The string identifier of the associated RestApi.
", "UpdateIntegrationResponseRequest$resourceId": "Specifies an update integration response request's resource identifier.
", "UpdateIntegrationResponseRequest$httpMethod": "Specifies an update integration response request's HTTP method.
", "UpdateMethodRequest$restApiId": "The string identifier of the associated RestApi.
", "UpdateMethodRequest$resourceId": "The Resource identifier for the Method resource.
", "UpdateMethodRequest$httpMethod": "The HTTP verb of the Method resource.
", "UpdateMethodResponseRequest$restApiId": "The string identifier of the associated RestApi.
", "UpdateMethodResponseRequest$resourceId": "The Resource identifier for the MethodResponse resource.
", "UpdateMethodResponseRequest$httpMethod": "The HTTP verb of the Method resource.
", "UpdateModelRequest$restApiId": "The string identifier of the associated RestApi.
", "UpdateModelRequest$modelName": "The name of the model to update.
", "UpdateRequestValidatorRequest$restApiId": "The string identifier of the associated RestApi.
", "UpdateRequestValidatorRequest$requestValidatorId": "[Required] The identifier of RequestValidator to be updated.
", "UpdateResourceRequest$restApiId": "The string identifier of the associated RestApi.
", "UpdateResourceRequest$resourceId": "The identifier of the Resource resource.
", "UpdateRestApiRequest$restApiId": "The string identifier of the associated RestApi.
", "UpdateStageRequest$restApiId": "The string identifier of the associated RestApi.
", "UpdateStageRequest$stageName": "The name of the Stage resource to change information about.
", "UpdateUsagePlanRequest$usagePlanId": "The Id of the to-be-updated usage plan.
", "UpdateUsageRequest$usagePlanId": "The Id of the usage plan associated with the usage data.
", "UpdateUsageRequest$keyId": "The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
", "UpdateVpcLinkRequest$vpcLinkId": "[Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", "Usage$usagePlanId": "The plan Id associated with this usage data.
", "Usage$startDate": "The starting date of the usage data.
", "Usage$endDate": "The ending date of the usage data.
", "Usage$position": null, "UsagePlan$id": "The identifier of a UsagePlan resource.
", "UsagePlan$name": "The name of a usage plan.
", "UsagePlan$description": "The description of a usage plan.
", "UsagePlan$productCode": "The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
", "UsagePlanKey$id": "The Id of a usage plan key.
", "UsagePlanKey$type": "The type of a usage plan key. Currently, the valid key type is API_KEY.
The value of a usage plan key.
", "UsagePlanKey$name": "The name of a usage plan key.
", "UsagePlanKeys$position": null, "UsagePlans$position": null, "VpcLink$id": "The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", "VpcLink$name": "The name used to label and identify the VPC link.
", "VpcLink$description": "The description of the VPC link.
", "VpcLink$statusMessage": "A description about the VPC link status.
", "VpcLinks$position": null } }, "Template": { "base": "Represents a mapping template used to transform a payload.
", "refs": { } }, "TestInvokeAuthorizerRequest": { "base": "Make a request to simulate the execution of an Authorizer.
", "refs": { } }, "TestInvokeAuthorizerResponse": { "base": "Represents the response of the test invoke request for a custom Authorizer
", "refs": { } }, "TestInvokeMethodRequest": { "base": "Make a request to simulate the execution of a Method.
", "refs": { } }, "TestInvokeMethodResponse": { "base": "Represents the response of the test invoke request in the HTTP method.
", "refs": { } }, "ThrottleSettings": { "base": "The API request rate limits.
", "refs": { "Account$throttleSettings": "Specifies the API request limits configured for the current Account.
", "CreateUsagePlanRequest$throttle": "The throttling limits of the usage plan.
", "UsagePlan$throttle": "The request throttle limits of a usage plan.
" } }, "Timestamp": { "base": null, "refs": { "ApiKey$createdDate": "The timestamp when the API Key was created.
", "ApiKey$lastUpdatedDate": "The timestamp when the API Key was last updated.
", "ClientCertificate$createdDate": "The timestamp when the client certificate was created.
", "ClientCertificate$expirationDate": "The timestamp when the client certificate will expire.
", "Deployment$createdDate": "The date and time that the deployment resource was created.
", "DocumentationVersion$createdDate": "The date when the API documentation snapshot is created.
", "DomainName$certificateUploadDate": "The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
", "RestApi$createdDate": "The timestamp when the API was created.
", "Stage$createdDate": "The timestamp when the stage was created.
", "Stage$lastUpdatedDate": "The timestamp when the stage last updated.
" } }, "TooManyRequestsException": { "base": "The request has reached its throttling limit. Retry after the specified time period.
", "refs": { } }, "UnauthorizedCacheControlHeaderStrategy": { "base": null, "refs": { "MethodSetting$unauthorizedCacheControlHeaderStrategy": "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.
The request is denied because the caller has insufficient permissions.
", "refs": { } }, "UpdateAccountRequest": { "base": "Requests API Gateway to change information about the current Account resource.
", "refs": { } }, "UpdateApiKeyRequest": { "base": "A request to change information about an ApiKey resource.
", "refs": { } }, "UpdateAuthorizerRequest": { "base": "Request to update an existing Authorizer resource.
", "refs": { } }, "UpdateBasePathMappingRequest": { "base": "A request to change information about the BasePathMapping resource.
", "refs": { } }, "UpdateClientCertificateRequest": { "base": "A request to change information about an ClientCertificate resource.
", "refs": { } }, "UpdateDeploymentRequest": { "base": "Requests API Gateway to change information about a Deployment resource.
", "refs": { } }, "UpdateDocumentationPartRequest": { "base": "Updates an existing documentation part of a given API.
", "refs": { } }, "UpdateDocumentationVersionRequest": { "base": "Updates an existing documentation version of an API.
", "refs": { } }, "UpdateDomainNameRequest": { "base": "A request to change information about the DomainName resource.
", "refs": { } }, "UpdateGatewayResponseRequest": { "base": "Updates a GatewayResponse of a specified response type on the given RestApi.
", "refs": { } }, "UpdateIntegrationRequest": { "base": "Represents an update integration request.
", "refs": { } }, "UpdateIntegrationResponseRequest": { "base": "Represents an update integration response request.
", "refs": { } }, "UpdateMethodRequest": { "base": "Request to update an existing Method resource.
", "refs": { } }, "UpdateMethodResponseRequest": { "base": "A request to update an existing MethodResponse resource.
", "refs": { } }, "UpdateModelRequest": { "base": "Request to update an existing model in an existing RestApi resource.
", "refs": { } }, "UpdateRequestValidatorRequest": { "base": "Updates a RequestValidator of a given RestApi.
", "refs": { } }, "UpdateResourceRequest": { "base": "Request to change information about a Resource resource.
", "refs": { } }, "UpdateRestApiRequest": { "base": "Request to update an existing RestApi resource in your collection.
", "refs": { } }, "UpdateStageRequest": { "base": "Requests API Gateway to change information about a Stage resource.
", "refs": { } }, "UpdateUsagePlanRequest": { "base": "The PATCH request to update a usage plan of a given plan Id.
", "refs": { } }, "UpdateUsageRequest": { "base": "The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.
", "refs": { } }, "UpdateVpcLinkRequest": { "base": "Updates an existing VpcLink of a specified identifier.
", "refs": { } }, "Usage": { "base": "Represents the usage data of a usage plan.
Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.
In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.
Represents a usage plan key to identify a plan customer.
To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.
Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
", "refs": { } }, "UsagePlans": { "base": "Represents a collection of usage plans for an AWS account.
", "refs": { } }, "VpcLink": { "base": "A API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integraiton 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.
The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.
The collection of VPC links under the caller's account in a region.
", "refs": { } } } }