# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [CreateApiKey](API_CreateApiKey.md) 
+  [CreateAuthorizer](API_CreateAuthorizer.md) 
+  [CreateBasePathMapping](API_CreateBasePathMapping.md) 
+  [CreateDeployment](API_CreateDeployment.md) 
+  [CreateDocumentationPart](API_CreateDocumentationPart.md) 
+  [CreateDocumentationVersion](API_CreateDocumentationVersion.md) 
+  [CreateDomainName](API_CreateDomainName.md) 
+  [CreateDomainNameAccessAssociation](API_CreateDomainNameAccessAssociation.md) 
+  [CreateModel](API_CreateModel.md) 
+  [CreateRequestValidator](API_CreateRequestValidator.md) 
+  [CreateResource](API_CreateResource.md) 
+  [CreateRestApi](API_CreateRestApi.md) 
+  [CreateStage](API_CreateStage.md) 
+  [CreateUsagePlan](API_CreateUsagePlan.md) 
+  [CreateUsagePlanKey](API_CreateUsagePlanKey.md) 
+  [CreateVpcLink](API_CreateVpcLink.md) 
+  [DeleteApiKey](API_DeleteApiKey.md) 
+  [DeleteAuthorizer](API_DeleteAuthorizer.md) 
+  [DeleteBasePathMapping](API_DeleteBasePathMapping.md) 
+  [DeleteClientCertificate](API_DeleteClientCertificate.md) 
+  [DeleteDeployment](API_DeleteDeployment.md) 
+  [DeleteDocumentationPart](API_DeleteDocumentationPart.md) 
+  [DeleteDocumentationVersion](API_DeleteDocumentationVersion.md) 
+  [DeleteDomainName](API_DeleteDomainName.md) 
+  [DeleteDomainNameAccessAssociation](API_DeleteDomainNameAccessAssociation.md) 
+  [DeleteGatewayResponse](API_DeleteGatewayResponse.md) 
+  [DeleteIntegration](API_DeleteIntegration.md) 
+  [DeleteIntegrationResponse](API_DeleteIntegrationResponse.md) 
+  [DeleteMethod](API_DeleteMethod.md) 
+  [DeleteMethodResponse](API_DeleteMethodResponse.md) 
+  [DeleteModel](API_DeleteModel.md) 
+  [DeleteRequestValidator](API_DeleteRequestValidator.md) 
+  [DeleteResource](API_DeleteResource.md) 
+  [DeleteRestApi](API_DeleteRestApi.md) 
+  [DeleteStage](API_DeleteStage.md) 
+  [DeleteUsagePlan](API_DeleteUsagePlan.md) 
+  [DeleteUsagePlanKey](API_DeleteUsagePlanKey.md) 
+  [DeleteVpcLink](API_DeleteVpcLink.md) 
+  [FlushStageAuthorizersCache](API_FlushStageAuthorizersCache.md) 
+  [FlushStageCache](API_FlushStageCache.md) 
+  [GenerateClientCertificate](API_GenerateClientCertificate.md) 
+  [GetAccount](API_GetAccount.md) 
+  [GetApiKey](API_GetApiKey.md) 
+  [GetApiKeys](API_GetApiKeys.md) 
+  [GetAuthorizer](API_GetAuthorizer.md) 
+  [GetAuthorizers](API_GetAuthorizers.md) 
+  [GetBasePathMapping](API_GetBasePathMapping.md) 
+  [GetBasePathMappings](API_GetBasePathMappings.md) 
+  [GetClientCertificate](API_GetClientCertificate.md) 
+  [GetClientCertificates](API_GetClientCertificates.md) 
+  [GetDeployment](API_GetDeployment.md) 
+  [GetDeployments](API_GetDeployments.md) 
+  [GetDocumentationPart](API_GetDocumentationPart.md) 
+  [GetDocumentationParts](API_GetDocumentationParts.md) 
+  [GetDocumentationVersion](API_GetDocumentationVersion.md) 
+  [GetDocumentationVersions](API_GetDocumentationVersions.md) 
+  [GetDomainName](API_GetDomainName.md) 
+  [GetDomainNameAccessAssociations](API_GetDomainNameAccessAssociations.md) 
+  [GetDomainNames](API_GetDomainNames.md) 
+  [GetExport](API_GetExport.md) 
+  [GetGatewayResponse](API_GetGatewayResponse.md) 
+  [GetGatewayResponses](API_GetGatewayResponses.md) 
+  [GetIntegration](API_GetIntegration.md) 
+  [GetIntegrationResponse](API_GetIntegrationResponse.md) 
+  [GetMethod](API_GetMethod.md) 
+  [GetMethodResponse](API_GetMethodResponse.md) 
+  [GetModel](API_GetModel.md) 
+  [GetModels](API_GetModels.md) 
+  [GetModelTemplate](API_GetModelTemplate.md) 
+  [GetRequestValidator](API_GetRequestValidator.md) 
+  [GetRequestValidators](API_GetRequestValidators.md) 
+  [GetResource](API_GetResource.md) 
+  [GetResources](API_GetResources.md) 
+  [GetRestApi](API_GetRestApi.md) 
+  [GetRestApis](API_GetRestApis.md) 
+  [GetSdk](API_GetSdk.md) 
+  [GetSdkType](API_GetSdkType.md) 
+  [GetSdkTypes](API_GetSdkTypes.md) 
+  [GetStage](API_GetStage.md) 
+  [GetStages](API_GetStages.md) 
+  [GetTags](API_GetTags.md) 
+  [GetUsage](API_GetUsage.md) 
+  [GetUsagePlan](API_GetUsagePlan.md) 
+  [GetUsagePlanKey](API_GetUsagePlanKey.md) 
+  [GetUsagePlanKeys](API_GetUsagePlanKeys.md) 
+  [GetUsagePlans](API_GetUsagePlans.md) 
+  [GetVpcLink](API_GetVpcLink.md) 
+  [GetVpcLinks](API_GetVpcLinks.md) 
+  [ImportApiKeys](API_ImportApiKeys.md) 
+  [ImportDocumentationParts](API_ImportDocumentationParts.md) 
+  [ImportRestApi](API_ImportRestApi.md) 
+  [PutGatewayResponse](API_PutGatewayResponse.md) 
+  [PutIntegration](API_PutIntegration.md) 
+  [PutIntegrationResponse](API_PutIntegrationResponse.md) 
+  [PutMethod](API_PutMethod.md) 
+  [PutMethodResponse](API_PutMethodResponse.md) 
+  [PutRestApi](API_PutRestApi.md) 
+  [RejectDomainNameAccessAssociation](API_RejectDomainNameAccessAssociation.md) 
+  [TagResource](API_TagResource.md) 
+  [TestInvokeAuthorizer](API_TestInvokeAuthorizer.md) 
+  [TestInvokeMethod](API_TestInvokeMethod.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAccount](API_UpdateAccount.md) 
+  [UpdateApiKey](API_UpdateApiKey.md) 
+  [UpdateAuthorizer](API_UpdateAuthorizer.md) 
+  [UpdateBasePathMapping](API_UpdateBasePathMapping.md) 
+  [UpdateClientCertificate](API_UpdateClientCertificate.md) 
+  [UpdateDeployment](API_UpdateDeployment.md) 
+  [UpdateDocumentationPart](API_UpdateDocumentationPart.md) 
+  [UpdateDocumentationVersion](API_UpdateDocumentationVersion.md) 
+  [UpdateDomainName](API_UpdateDomainName.md) 
+  [UpdateGatewayResponse](API_UpdateGatewayResponse.md) 
+  [UpdateIntegration](API_UpdateIntegration.md) 
+  [UpdateIntegrationResponse](API_UpdateIntegrationResponse.md) 
+  [UpdateMethod](API_UpdateMethod.md) 
+  [UpdateMethodResponse](API_UpdateMethodResponse.md) 
+  [UpdateModel](API_UpdateModel.md) 
+  [UpdateRequestValidator](API_UpdateRequestValidator.md) 
+  [UpdateResource](API_UpdateResource.md) 
+  [UpdateRestApi](API_UpdateRestApi.md) 
+  [UpdateStage](API_UpdateStage.md) 
+  [UpdateUsage](API_UpdateUsage.md) 
+  [UpdateUsagePlan](API_UpdateUsagePlan.md) 
+  [UpdateVpcLink](API_UpdateVpcLink.md) 

# CreateApiKey
<a name="API_CreateApiKey"></a>

Create an ApiKey resource. 

## Request Syntax
<a name="API_CreateApiKey_RequestSyntax"></a>

```
POST /apikeys HTTP/1.1
Content-type: application/json

{
   "customerId": "string",
   "description": "string",
   "enabled": boolean,
   "generateDistinctId": boolean,
   "name": "string",
   "stageKeys": [ 
      { 
         "restApiId": "string",
         "stageName": "string"
      }
   ],
   "tags": { 
      "string" : "string" 
   },
   "value": "string"
}
```

## URI Request Parameters
<a name="API_CreateApiKey_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateApiKey_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [customerId](#API_CreateApiKey_RequestSyntax) **   <a name="apigw-CreateApiKey-request-customerId"></a>
An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.  
Type: String  
Required: No

 ** [description](#API_CreateApiKey_RequestSyntax) **   <a name="apigw-CreateApiKey-request-description"></a>
The description of the ApiKey.  
Type: String  
Required: No

 ** [enabled](#API_CreateApiKey_RequestSyntax) **   <a name="apigw-CreateApiKey-request-enabled"></a>
Specifies whether the ApiKey can be used by callers.  
Type: Boolean  
Required: No

 ** [generateDistinctId](#API_CreateApiKey_RequestSyntax) **   <a name="apigw-CreateApiKey-request-generateDistinctId"></a>
Specifies whether (`true`) or not (`false`) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.  
Type: Boolean  
Required: No

 ** [name](#API_CreateApiKey_RequestSyntax) **   <a name="apigw-CreateApiKey-request-name"></a>
The name of the ApiKey.  
Type: String  
Required: No

 ** [stageKeys](#API_CreateApiKey_RequestSyntax) **   <a name="apigw-CreateApiKey-request-stageKeys"></a>
DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.  
Type: Array of [StageKey](API_StageKey.md) objects  
Required: No

 ** [tags](#API_CreateApiKey_RequestSyntax) **   <a name="apigw-CreateApiKey-request-tags"></a>
The key-value map of strings. The valid character set is [a-zA-Z\$1-=.\$1:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.  
Type: String to string map  
Required: No

 ** [value](#API_CreateApiKey_RequestSyntax) **   <a name="apigw-CreateApiKey-request-value"></a>
Specifies a value of the API key.  
Type: String  
Required: No

## Response Syntax
<a name="API_CreateApiKey_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "createdDate": number,
   "customerId": "string",
   "description": "string",
   "enabled": boolean,
   "id": "string",
   "lastUpdatedDate": number,
   "name": "string",
   "stageKeys": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "value": "string"
}
```

## Response Elements
<a name="API_CreateApiKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [createdDate](#API_CreateApiKey_ResponseSyntax) **   <a name="apigw-CreateApiKey-response-createdDate"></a>
The timestamp when the API Key was created.  
Type: Timestamp

 ** [customerId](#API_CreateApiKey_ResponseSyntax) **   <a name="apigw-CreateApiKey-response-customerId"></a>
An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.  
Type: String

 ** [description](#API_CreateApiKey_ResponseSyntax) **   <a name="apigw-CreateApiKey-response-description"></a>
The description of the API Key.  
Type: String

 ** [enabled](#API_CreateApiKey_ResponseSyntax) **   <a name="apigw-CreateApiKey-response-enabled"></a>
Specifies whether the API Key can be used by callers.  
Type: Boolean

 ** [id](#API_CreateApiKey_ResponseSyntax) **   <a name="apigw-CreateApiKey-response-id"></a>
The identifier of the API Key.  
Type: String

 ** [lastUpdatedDate](#API_CreateApiKey_ResponseSyntax) **   <a name="apigw-CreateApiKey-response-lastUpdatedDate"></a>
The timestamp when the API Key was last updated.  
Type: Timestamp

 ** [name](#API_CreateApiKey_ResponseSyntax) **   <a name="apigw-CreateApiKey-response-name"></a>
The name of the API Key.  
Type: String

 ** [stageKeys](#API_CreateApiKey_ResponseSyntax) **   <a name="apigw-CreateApiKey-response-stageKeys"></a>
A list of Stage resources that are associated with the ApiKey resource.  
Type: Array of strings

 ** [tags](#API_CreateApiKey_ResponseSyntax) **   <a name="apigw-CreateApiKey-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [value](#API_CreateApiKey_ResponseSyntax) **   <a name="apigw-CreateApiKey-response-value"></a>
The value of the API Key.  
Type: String

## Errors
<a name="API_CreateApiKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateApiKey_Examples"></a>

### Create an API key
<a name="API_CreateApiKey_Example_1"></a>

 The following example creates an API key. 

#### Sample Request
<a name="API_CreateApiKey_Example_1_Request"></a>

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

{
  "name" : "my_api_key",
  "description" : "My API key",
  "enabled" : "false",
  "stageKeys" : [ {
    "restApiId" : "uycll6xg9a",
    "stageName" : "beta"
  } ]
}
```

#### Sample Response
<a name="API_CreateApiKey_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-apikey-{rel}.html",
      "name": "apikey",
      "templated": true
    },
    "self": {
      "href": "/apikeys/a2TprUZuzf2EKbbmMUotDaHYGg8kgxFypcarGved6"
    },
    "apikey:delete": {
      "href": "/apikeys/a2TprUZuzf2EKbbmMUotDaHYGg8kgxFypcarGved6"
    },
    "apikey:update": {
      "href": "/apikeys/a2TprUZuzf2EKbbmMUotDaHYGg8kgxFypcarGved6"
    }
  },
  "createdDate": "2016-06-08T22:21:56Z",
  "description": "My API key",
  "enabled": false,
  "id": "a2TprUZuzf2EKbbmMUotDaHYGg8kgxFypcarGved6",
  "lastUpdatedDate": "2016-06-08T22:21:56Z",
  "name": "my_api_key",
  "stageKeys": "uycll6xg9a/beta"
}
```

## See Also
<a name="API_CreateApiKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateApiKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateApiKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateApiKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateApiKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateApiKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateApiKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateApiKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateApiKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateApiKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateApiKey) 

# CreateAuthorizer
<a name="API_CreateAuthorizer"></a>

Adds a new Authorizer resource to an existing RestApi resource.

## Request Syntax
<a name="API_CreateAuthorizer_RequestSyntax"></a>

```
POST /restapis/restapi_id/authorizers HTTP/1.1
Content-type: application/json

{
   "authorizerCredentials": "string",
   "authorizerResultTtlInSeconds": number,
   "authorizerUri": "string",
   "authType": "string",
   "identitySource": "string",
   "identityValidationExpression": "string",
   "name": "string",
   "providerARNs": [ "string" ],
   "type": "string"
}
```

## URI Request Parameters
<a name="API_CreateAuthorizer_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_CreateAuthorizer_RequestSyntax) **   <a name="apigw-CreateAuthorizer-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_CreateAuthorizer_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [authorizerCredentials](#API_CreateAuthorizer_RequestSyntax) **   <a name="apigw-CreateAuthorizer-request-authorizerCredentials"></a>
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.  
Type: String  
Required: No

 ** [authorizerResultTtlInSeconds](#API_CreateAuthorizer_RequestSyntax) **   <a name="apigw-CreateAuthorizer-request-authorizerResultTtlInSeconds"></a>
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.  
Type: Integer  
Required: No

 ** [authorizerUri](#API_CreateAuthorizer_RequestSyntax) **   <a name="apigw-CreateAuthorizer-request-authorizerUri"></a>
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`.  
Type: String  
Required: No

 ** [authType](#API_CreateAuthorizer_RequestSyntax) **   <a name="apigw-CreateAuthorizer-request-authType"></a>
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.  
Type: String  
Required: No

 ** [identitySource](#API_CreateAuthorizer_RequestSyntax) **   <a name="apigw-CreateAuthorizer-request-identitySource"></a>
The identity source for which authorization is requested. For a `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is `Auth`, the header mapping expression is `method.request.header.Auth`. For the `REQUEST` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an `Auth` header, a `Name` query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`. These parameters will be used to derive the authorization caching key and to perform runtime validation of the `REQUEST` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.  
Type: String  
Required: No

 ** [identityValidationExpression](#API_CreateAuthorizer_RequestSyntax) **   <a name="apigw-CreateAuthorizer-request-identityValidationExpression"></a>
A validation expression for the incoming identity token. For `TOKEN` authorizers, this value is a regular expression. For `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the `REQUEST` authorizer.  
Type: String  
Required: No

 ** [name](#API_CreateAuthorizer_RequestSyntax) **   <a name="apigw-CreateAuthorizer-request-name"></a>
The name of the authorizer.  
Type: String  
Required: Yes

 ** [providerARNs](#API_CreateAuthorizer_RequestSyntax) **   <a name="apigw-CreateAuthorizer-request-providerARNs"></a>
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.   
Type: Array of strings  
Required: No

 ** [type](#API_CreateAuthorizer_RequestSyntax) **   <a name="apigw-CreateAuthorizer-request-type"></a>
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.  
Type: String  
Valid Values: `TOKEN | REQUEST | COGNITO_USER_POOLS`   
Required: Yes

## Response Syntax
<a name="API_CreateAuthorizer_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "authorizerCredentials": "string",
   "authorizerResultTtlInSeconds": number,
   "authorizerUri": "string",
   "authType": "string",
   "id": "string",
   "identitySource": "string",
   "identityValidationExpression": "string",
   "name": "string",
   "providerARNs": [ "string" ],
   "type": "string"
}
```

## Response Elements
<a name="API_CreateAuthorizer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [authorizerCredentials](#API_CreateAuthorizer_ResponseSyntax) **   <a name="apigw-CreateAuthorizer-response-authorizerCredentials"></a>
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.  
Type: String

 ** [authorizerResultTtlInSeconds](#API_CreateAuthorizer_ResponseSyntax) **   <a name="apigw-CreateAuthorizer-response-authorizerResultTtlInSeconds"></a>
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.  
Type: Integer

 ** [authorizerUri](#API_CreateAuthorizer_ResponseSyntax) **   <a name="apigw-CreateAuthorizer-response-authorizerUri"></a>
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`.  
Type: String

 ** [authType](#API_CreateAuthorizer_ResponseSyntax) **   <a name="apigw-CreateAuthorizer-response-authType"></a>
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.  
Type: String

 ** [id](#API_CreateAuthorizer_ResponseSyntax) **   <a name="apigw-CreateAuthorizer-response-id"></a>
The identifier for the authorizer resource.  
Type: String

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

 ** [identityValidationExpression](#API_CreateAuthorizer_ResponseSyntax) **   <a name="apigw-CreateAuthorizer-response-identityValidationExpression"></a>
A validation expression for the incoming identity token. For `TOKEN` authorizers, this value is a regular expression. For `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the `REQUEST` authorizer.  
Type: String

 ** [name](#API_CreateAuthorizer_ResponseSyntax) **   <a name="apigw-CreateAuthorizer-response-name"></a>
The name of the authorizer.  
Type: String

 ** [providerARNs](#API_CreateAuthorizer_ResponseSyntax) **   <a name="apigw-CreateAuthorizer-response-providerARNs"></a>
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.   
Type: Array of strings

 ** [type](#API_CreateAuthorizer_ResponseSyntax) **   <a name="apigw-CreateAuthorizer-response-type"></a>
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.  
Type: String  
Valid Values: `TOKEN | REQUEST | COGNITO_USER_POOLS` 

## Errors
<a name="API_CreateAuthorizer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateAuthorizer_Examples"></a>

### Example: Create a custom authorizer
<a name="API_CreateAuthorizer_Example_1"></a>

This example illustrates one usage of CreateAuthorizer.

#### Sample Request
<a name="API_CreateAuthorizer_Example_1_Request"></a>

```
POST /restapis/mxsmn867vb/authorizers HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T232342Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
"authType": "custom",
"authorizerResultTtlInSeconds": 300,
"authorizerCredentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole",
"authorizerUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789012:function:myApiAuthroizer/invocations",
"identitySource": "method.request.header.CustAuth",
"name": "my-other-cust-auth",
"type": "TOKEN"
}"
```

#### Sample Response
<a name="API_CreateAuthorizer_Example_1_Response"></a>

```
{
"_links": {
  "curies": {
    "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-authorizer-{rel}.html",
    "name": "authorizer",
    "templated": true
  },
  "self": {
    "href": "/restapis/mxsmn867vb/authorizers/4unj71"
  },
  "authorizer:delete": {
    "href": "/restapis/mxsmn867vb/authorizers/4unj71"
  },
  "authorizer:update": {
    "href": "/restapis/mxsmn867vb/authorizers/4unj71"
  }
},
"authType": "custom",
"authorizerCredentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole",
"authorizerResultTtlInSeconds": 300,
"authorizerUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789012:function:myApiAuthroizer/invocations",
"id": "4unj71",
"identitySource": "method.request.header.CustAuth",
"name": "my-other-cust-auth",
"type": "TOKEN"
}
```

## See Also
<a name="API_CreateAuthorizer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateAuthorizer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateAuthorizer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateAuthorizer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateAuthorizer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateAuthorizer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateAuthorizer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateAuthorizer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateAuthorizer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateAuthorizer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateAuthorizer) 

# CreateBasePathMapping
<a name="API_CreateBasePathMapping"></a>

Creates a new BasePathMapping resource.

## Request Syntax
<a name="API_CreateBasePathMapping_RequestSyntax"></a>

```
POST /domainnames/domain_name/basepathmappings?domainNameId=domainNameId HTTP/1.1
Content-type: application/json

{
   "basePath": "string",
   "restApiId": "string",
   "stage": "string"
}
```

## URI Request Parameters
<a name="API_CreateBasePathMapping_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domain\$1name](#API_CreateBasePathMapping_RequestSyntax) **   <a name="apigw-CreateBasePathMapping-request-uri-domainName"></a>
The domain name of the BasePathMapping resource to create.  
Required: Yes

 ** [domainNameId](#API_CreateBasePathMapping_RequestSyntax) **   <a name="apigw-CreateBasePathMapping-request-uri-domainNameId"></a>
The identifier for the domain name resource. Required for private custom domain names.

## Request Body
<a name="API_CreateBasePathMapping_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [basePath](#API_CreateBasePathMapping_RequestSyntax) **   <a name="apigw-CreateBasePathMapping-request-basePath"></a>
The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.  
Type: String  
Required: No

 ** [restApiId](#API_CreateBasePathMapping_RequestSyntax) **   <a name="apigw-CreateBasePathMapping-request-restApiId"></a>
The string identifier of the associated RestApi.  
Type: String  
Required: Yes

 ** [stage](#API_CreateBasePathMapping_RequestSyntax) **   <a name="apigw-CreateBasePathMapping-request-stage"></a>
The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.  
Type: String  
Required: No

## Response Syntax
<a name="API_CreateBasePathMapping_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "basePath": "string",
   "restApiId": "string",
   "stage": "string"
}
```

## Response Elements
<a name="API_CreateBasePathMapping_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [basePath](#API_CreateBasePathMapping_ResponseSyntax) **   <a name="apigw-CreateBasePathMapping-response-basePath"></a>
The base path name that callers of the API must provide as part of the URL after the domain name.  
Type: String

 ** [restApiId](#API_CreateBasePathMapping_ResponseSyntax) **   <a name="apigw-CreateBasePathMapping-response-restApiId"></a>
The string identifier of the associated RestApi.  
Type: String

 ** [stage](#API_CreateBasePathMapping_ResponseSyntax) **   <a name="apigw-CreateBasePathMapping-response-stage"></a>
The name of the associated stage.  
Type: String

## Errors
<a name="API_CreateBasePathMapping_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateBasePathMapping_Examples"></a>

### Creates base path mapping for an API
<a name="API_CreateBasePathMapping_Example_1"></a>

 The following example request creates a `TestApi` base path that is mapped the `fugvjdxtri` API in the `stage1` stage. 

#### Sample Request
<a name="API_CreateBasePathMapping_Example_1_Request"></a>

```
POST /domainnames/a.b.c.com/basepathmappings HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160615T012033Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160615/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "basepath" : "TestApi",
  "restApiId" : "fugvjdxtri",
  "stage" : "stage1"
}
```

#### Sample Response
<a name="API_CreateBasePathMapping_Example_1_Response"></a>

```
{
  "_links": {upd
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-basepathmapping-{rel}.html",
      "name": "basepathmapping",
      "templated": true
    },
    "self": {
      "href": "/domainnames/a.b.c.com/basepathmappings/TestApi"
    },
    "basepathmapping:create": {
      "href": "/domainnames/a.b.c.com/basepathmappings"
    },
    "basepathmapping:delete": {
      "href": "/domainnames/a.b.c.com/basepathmappings/TestApi"
    },
    "basepathmapping:update": {
      "href": "/domainnames/a.b.c.com/basepathmappings/TestApi"
    }
  },
  "basepath": "TestApi",
  "restApiId": "fugvjdxtri",
  "stage": "stage1"
}
```

## See Also
<a name="API_CreateBasePathMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateBasePathMapping) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateBasePathMapping) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateBasePathMapping) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateBasePathMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateBasePathMapping) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateBasePathMapping) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateBasePathMapping) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateBasePathMapping) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateBasePathMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateBasePathMapping) 

# CreateDeployment
<a name="API_CreateDeployment"></a>

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

## Request Syntax
<a name="API_CreateDeployment_RequestSyntax"></a>

```
POST /restapis/restapi_id/deployments HTTP/1.1
Content-type: application/json

{
   "cacheClusterEnabled": boolean,
   "cacheClusterSize": "string",
   "canarySettings": { 
      "percentTraffic": number,
      "stageVariableOverrides": { 
         "string" : "string" 
      },
      "useStageCache": boolean
   },
   "description": "string",
   "stageDescription": "string",
   "stageName": "string",
   "tracingEnabled": boolean,
   "variables": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateDeployment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_CreateDeployment_RequestSyntax) **   <a name="apigw-CreateDeployment-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_CreateDeployment_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [cacheClusterEnabled](#API_CreateDeployment_RequestSyntax) **   <a name="apigw-CreateDeployment-request-cacheClusterEnabled"></a>
Enables a cache cluster for the Stage resource specified in the input.  
Type: Boolean  
Required: No

 ** [cacheClusterSize](#API_CreateDeployment_RequestSyntax) **   <a name="apigw-CreateDeployment-request-cacheClusterSize"></a>
The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).  
Type: String  
Valid Values: `0.5 | 1.6 | 6.1 | 13.5 | 28.4 | 58.2 | 118 | 237`   
Required: No

 ** [canarySettings](#API_CreateDeployment_RequestSyntax) **   <a name="apigw-CreateDeployment-request-canarySettings"></a>
The input configuration for the canary deployment when the deployment is a canary release deployment.   
Type: [DeploymentCanarySettings](API_DeploymentCanarySettings.md) object  
Required: No

 ** [description](#API_CreateDeployment_RequestSyntax) **   <a name="apigw-CreateDeployment-request-description"></a>
The description for the Deployment resource to create.  
Type: String  
Required: No

 ** [stageDescription](#API_CreateDeployment_RequestSyntax) **   <a name="apigw-CreateDeployment-request-stageDescription"></a>
The description of the Stage resource for the Deployment resource to create.  
Type: String  
Required: No

 ** [stageName](#API_CreateDeployment_RequestSyntax) **   <a name="apigw-CreateDeployment-request-stageName"></a>
The name of the Stage resource for the Deployment resource to create.  
Type: String  
Required: No

 ** [tracingEnabled](#API_CreateDeployment_RequestSyntax) **   <a name="apigw-CreateDeployment-request-tracingEnabled"></a>
Specifies whether active tracing with X-ray is enabled for the Stage.  
Type: Boolean  
Required: No

 ** [variables](#API_CreateDeployment_RequestSyntax) **   <a name="apigw-CreateDeployment-request-variables"></a>
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-._~:/?#&=,]+`.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_CreateDeployment_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "apiSummary": { 
      "string" : { 
         "string" : { 
            "apiKeyRequired": boolean,
            "authorizationType": "string"
         }
      }
   },
   "createdDate": number,
   "description": "string",
   "id": "string"
}
```

## Response Elements
<a name="API_CreateDeployment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [apiSummary](#API_CreateDeployment_ResponseSyntax) **   <a name="apigw-CreateDeployment-response-apiSummary"></a>
A summary of the RestApi at the date and time that the deployment resource was created.  
Type: String to string to [MethodSnapshot](API_MethodSnapshot.md) object map map

 ** [createdDate](#API_CreateDeployment_ResponseSyntax) **   <a name="apigw-CreateDeployment-response-createdDate"></a>
The date and time that the deployment resource was created.  
Type: Timestamp

 ** [description](#API_CreateDeployment_ResponseSyntax) **   <a name="apigw-CreateDeployment-response-description"></a>
The description for the deployment resource.  
Type: String

 ** [id](#API_CreateDeployment_ResponseSyntax) **   <a name="apigw-CreateDeployment-response-id"></a>
The identifier for the deployment resource.  
Type: String

## Errors
<a name="API_CreateDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** ServiceUnavailableException **   
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.  
HTTP Status Code: 503

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateDeployment_Examples"></a>

### Create a deployment of an API
<a name="API_CreateDeployment_Example_1"></a>

This example illustrates one usage of CreateDeployment.

#### Sample Request
<a name="API_CreateDeployment_Example_1_Request"></a>

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

{
  "stageName" : "stage1",
  "stageDescription" : "First stage",
  "description" : "First deployment",
  "cacheClusterEnabled" : "false",
  "variables" : {
    "sv1" : "opVar"
  }
}
```

#### Sample Response
<a name="API_CreateDeployment_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-deployment-{rel}.html",
      "name": "deployment",
      "templated": true
    },
    "self": {
      "href": "/restapis/fugvjdxtri/deployments/dzacq7"
    },
    "deployment:delete": {
      "href": "/restapis/fugvjdxtri/deployments/dzacq7"
    },
    "deployment:stages": {
      "href": "/restapis/fugvjdxtri/stages?deployment_id=dzacq7"
    },
    "deployment:update": {
      "href": "/restapis/fugvjdxtri/deployments/dzacq7"
    }
  },
  "createdDate": "2016-06-03T17:56:06Z",
  "description": "First deployment",
  "id": "dzacq7"
}
```

## See Also
<a name="API_CreateDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateDeployment) 

# CreateDocumentationPart
<a name="API_CreateDocumentationPart"></a>

Creates a documentation part.

## Request Syntax
<a name="API_CreateDocumentationPart_RequestSyntax"></a>

```
POST /restapis/restapi_id/documentation/parts HTTP/1.1
Content-type: application/json

{
   "location": { 
      "method": "string",
      "name": "string",
      "path": "string",
      "statusCode": "string",
      "type": "string"
   },
   "properties": "string"
}
```

## URI Request Parameters
<a name="API_CreateDocumentationPart_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_CreateDocumentationPart_RequestSyntax) **   <a name="apigw-CreateDocumentationPart-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_CreateDocumentationPart_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [location](#API_CreateDocumentationPart_RequestSyntax) **   <a name="apigw-CreateDocumentationPart-request-location"></a>
The location of the targeted API entity of the to-be-created documentation part.  
Type: [DocumentationPartLocation](API_DocumentationPartLocation.md) object  
Required: Yes

 ** [properties](#API_CreateDocumentationPart_RequestSyntax) **   <a name="apigw-CreateDocumentationPart-request-properties"></a>
The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_CreateDocumentationPart_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "id": "string",
   "location": { 
      "method": "string",
      "name": "string",
      "path": "string",
      "statusCode": "string",
      "type": "string"
   },
   "properties": "string"
}
```

## Response Elements
<a name="API_CreateDocumentationPart_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [id](#API_CreateDocumentationPart_ResponseSyntax) **   <a name="apigw-CreateDocumentationPart-response-id"></a>
The DocumentationPart identifier, generated by API Gateway when the `DocumentationPart` is created.  
Type: String

 ** [location](#API_CreateDocumentationPart_ResponseSyntax) **   <a name="apigw-CreateDocumentationPart-response-location"></a>
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.  
Type: [DocumentationPartLocation](API_DocumentationPartLocation.md) object

 ** [properties](#API_CreateDocumentationPart_ResponseSyntax) **   <a name="apigw-CreateDocumentationPart-response-properties"></a>
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 OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of `x-amazon-apigateway-documentation`.  
Type: String

## Errors
<a name="API_CreateDocumentationPart_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_CreateDocumentationPart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateDocumentationPart) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateDocumentationPart) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateDocumentationPart) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateDocumentationPart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateDocumentationPart) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateDocumentationPart) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateDocumentationPart) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateDocumentationPart) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateDocumentationPart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateDocumentationPart) 

# CreateDocumentationVersion
<a name="API_CreateDocumentationVersion"></a>

Creates a documentation version

## Request Syntax
<a name="API_CreateDocumentationVersion_RequestSyntax"></a>

```
POST /restapis/restapi_id/documentation/versions HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "documentationVersion": "string",
   "stageName": "string"
}
```

## URI Request Parameters
<a name="API_CreateDocumentationVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_CreateDocumentationVersion_RequestSyntax) **   <a name="apigw-CreateDocumentationVersion-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_CreateDocumentationVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_CreateDocumentationVersion_RequestSyntax) **   <a name="apigw-CreateDocumentationVersion-request-description"></a>
A description about the new documentation snapshot.  
Type: String  
Required: No

 ** [documentationVersion](#API_CreateDocumentationVersion_RequestSyntax) **   <a name="apigw-CreateDocumentationVersion-request-documentationVersion"></a>
The version identifier of the new snapshot.  
Type: String  
Required: Yes

 ** [stageName](#API_CreateDocumentationVersion_RequestSyntax) **   <a name="apigw-CreateDocumentationVersion-request-stageName"></a>
The stage name to be associated with the new documentation snapshot.  
Type: String  
Required: No

## Response Syntax
<a name="API_CreateDocumentationVersion_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "createdDate": number,
   "description": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_CreateDocumentationVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [createdDate](#API_CreateDocumentationVersion_ResponseSyntax) **   <a name="apigw-CreateDocumentationVersion-response-createdDate"></a>
The date when the API documentation snapshot is created.  
Type: Timestamp

 ** [description](#API_CreateDocumentationVersion_ResponseSyntax) **   <a name="apigw-CreateDocumentationVersion-response-description"></a>
The description of the API documentation snapshot.  
Type: String

 ** [version](#API_CreateDocumentationVersion_ResponseSyntax) **   <a name="apigw-CreateDocumentationVersion-response-version"></a>
The version identifier of the API documentation snapshot.  
Type: String

## Errors
<a name="API_CreateDocumentationVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_CreateDocumentationVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateDocumentationVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateDocumentationVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateDocumentationVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateDocumentationVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateDocumentationVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateDocumentationVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateDocumentationVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateDocumentationVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateDocumentationVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateDocumentationVersion) 

# CreateDomainName
<a name="API_CreateDomainName"></a>

Creates a new domain name.

## Request Syntax
<a name="API_CreateDomainName_RequestSyntax"></a>

```
POST /domainnames HTTP/1.1
Content-type: application/json

{
   "certificateArn": "string",
   "certificateBody": "string",
   "certificateChain": "string",
   "certificateName": "string",
   "certificatePrivateKey": "string",
   "domainName": "string",
   "endpointAccessMode": "string",
   "endpointConfiguration": { 
      "ipAddressType": "string",
      "types": [ "string" ],
      "vpcEndpointIds": [ "string" ]
   },
   "mutualTlsAuthentication": { 
      "truststoreUri": "string",
      "truststoreVersion": "string"
   },
   "ownershipVerificationCertificateArn": "string",
   "policy": "string",
   "regionalCertificateArn": "string",
   "regionalCertificateName": "string",
   "routingMode": "string",
   "securityPolicy": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateDomainName_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateDomainName_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [certificateArn](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-certificateArn"></a>
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. AWS Certificate Manager is the only supported source.  
Type: String  
Required: No

 ** [certificateBody](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-certificateBody"></a>
[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint or private endpoint for this domain name provided by your certificate authority.  
Type: String  
Required: No

 ** [certificateChain](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-certificateChain"></a>
[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.  
Type: String  
Required: No

 ** [certificateName](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-certificateName"></a>
The user-friendly name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.  
Type: String  
Required: No

 ** [certificatePrivateKey](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-certificatePrivateKey"></a>
[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.  
Type: String  
Required: No

 ** [domainName](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-domainName"></a>
The name of the DomainName resource.  
Type: String  
Required: Yes

 ** [endpointAccessMode](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-endpointAccessMode"></a>
 The endpoint access mode of the DomainName. Only available for DomainNames that use security policies that start with `SecurityPolicy_`.   
Type: String  
Valid Values: `BASIC | STRICT`   
Required: No

 ** [endpointConfiguration](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-endpointConfiguration"></a>
The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.   
Type: [EndpointConfiguration](API_EndpointConfiguration.md) object  
Required: No

 ** [mutualTlsAuthentication](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-mutualTlsAuthentication"></a>
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.  
Type: [MutualTlsAuthenticationInput](API_MutualTlsAuthenticationInput.md) object  
Required: No

 ** [ownershipVerificationCertificateArn](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-ownershipVerificationCertificateArn"></a>
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.  
Type: String  
Required: No

 ** [policy](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-policy"></a>
A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.  
Type: String  
Required: No

 ** [regionalCertificateArn](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-regionalCertificateArn"></a>
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.  
Type: String  
Required: No

 ** [regionalCertificateName](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-regionalCertificateName"></a>
The user-friendly name of the certificate that will be used by regional endpoint for this domain name.  
Type: String  
Required: No

 ** [routingMode](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-routingMode"></a>
 The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your APIs.   
Type: String  
Valid Values: `BASE_PATH_MAPPING_ONLY | ROUTING_RULE_ONLY | ROUTING_RULE_THEN_BASE_PATH_MAPPING`   
Required: No

 ** [securityPolicy](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-securityPolicy"></a>
The Transport Layer Security (TLS) version \$1 cipher suite for this DomainName.  
Type: String  
Valid Values: `TLS_1_0 | TLS_1_2 | SecurityPolicy_TLS13_1_3_2025_09 | SecurityPolicy_TLS13_1_3_FIPS_2025_09 | SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_PQ_2025_09 | SecurityPolicy_TLS13_1_2_2021_06 | SecurityPolicy_TLS13_2025_EDGE | SecurityPolicy_TLS12_PFS_2025_EDGE | SecurityPolicy_TLS12_2018_EDGE`   
Required: No

 ** [tags](#API_CreateDomainName_RequestSyntax) **   <a name="apigw-CreateDomainName-request-tags"></a>
The key-value map of strings. The valid character set is [a-zA-Z\$1-=.\$1:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_CreateDomainName_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "certificateArn": "string",
   "certificateName": "string",
   "certificateUploadDate": number,
   "distributionDomainName": "string",
   "distributionHostedZoneId": "string",
   "domainName": "string",
   "domainNameArn": "string",
   "domainNameId": "string",
   "domainNameStatus": "string",
   "domainNameStatusMessage": "string",
   "endpointAccessMode": "string",
   "endpointConfiguration": { 
      "ipAddressType": "string",
      "types": [ "string" ],
      "vpcEndpointIds": [ "string" ]
   },
   "managementPolicy": "string",
   "mutualTlsAuthentication": { 
      "truststoreUri": "string",
      "truststoreVersion": "string",
      "truststoreWarnings": [ "string" ]
   },
   "ownershipVerificationCertificateArn": "string",
   "policy": "string",
   "regionalCertificateArn": "string",
   "regionalCertificateName": "string",
   "regionalDomainName": "string",
   "regionalHostedZoneId": "string",
   "routingMode": "string",
   "securityPolicy": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_CreateDomainName_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [certificateArn](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-certificateArn"></a>
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. AWS Certificate Manager is the only supported source.  
Type: String

 ** [certificateName](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-certificateName"></a>
The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.  
Type: String

 ** [certificateUploadDate](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-certificateUploadDate"></a>
The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.  
Type: Timestamp

 ** [distributionDomainName](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-distributionDomainName"></a>
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.  
Type: String

 ** [distributionHostedZoneId](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-distributionHostedZoneId"></a>
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.   
Type: String

 ** [domainName](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-domainName"></a>
The custom domain name as an API host name, for example, `my-api.example.com`.  
Type: String

 ** [domainNameArn](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-domainNameArn"></a>
The ARN of the domain name.   
Type: String

 ** [domainNameId](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-domainNameId"></a>
The identifier for the domain name resource. Supported only for private custom domain names.  
Type: String

 ** [domainNameStatus](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-domainNameStatus"></a>
The status of the DomainName migration. The valid values are `AVAILABLE` and `UPDATING`. If the status is `UPDATING`, the domain cannot be modified further until the existing operation is complete. If it is `AVAILABLE`, the domain can be updated.  
Type: String  
Valid Values: `AVAILABLE | UPDATING | PENDING | PENDING_CERTIFICATE_REIMPORT | PENDING_OWNERSHIP_VERIFICATION | FAILED` 

 ** [domainNameStatusMessage](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-domainNameStatusMessage"></a>
An optional text message containing detailed information about status of the DomainName migration.  
Type: String

 ** [endpointAccessMode](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-endpointAccessMode"></a>
 The endpoint access mode of the DomainName.   
Type: String  
Valid Values: `BASIC | STRICT` 

 ** [endpointConfiguration](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-endpointConfiguration"></a>
The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.   
Type: [EndpointConfiguration](API_EndpointConfiguration.md) object

 ** [managementPolicy](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-managementPolicy"></a>
A stringified JSON policy document that applies to the API Gateway Management service for this DomainName. This policy document controls access for access association sources to create domain name access associations with this DomainName. Supported only for private custom domain names.  
Type: String

 ** [mutualTlsAuthentication](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-mutualTlsAuthentication"></a>
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.  
Type: [MutualTlsAuthentication](API_MutualTlsAuthentication.md) object

 ** [ownershipVerificationCertificateArn](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-ownershipVerificationCertificateArn"></a>
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.  
Type: String

 ** [policy](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-policy"></a>
A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.  
Type: String

 ** [regionalCertificateArn](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-regionalCertificateArn"></a>
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.  
Type: String

 ** [regionalCertificateName](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-regionalCertificateName"></a>
The name of the certificate that will be used for validating the regional domain name.  
Type: String

 ** [regionalDomainName](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-regionalDomainName"></a>
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.  
Type: String

 ** [regionalHostedZoneId](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-regionalHostedZoneId"></a>
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.   
Type: String

 ** [routingMode](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-routingMode"></a>
The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your APIs.  
Type: String  
Valid Values: `BASE_PATH_MAPPING_ONLY | ROUTING_RULE_ONLY | ROUTING_RULE_THEN_BASE_PATH_MAPPING` 

 ** [securityPolicy](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-securityPolicy"></a>
The Transport Layer Security (TLS) version \$1 cipher suite for this DomainName.  
Type: String  
Valid Values: `TLS_1_0 | TLS_1_2 | SecurityPolicy_TLS13_1_3_2025_09 | SecurityPolicy_TLS13_1_3_FIPS_2025_09 | SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_PQ_2025_09 | SecurityPolicy_TLS13_1_2_2021_06 | SecurityPolicy_TLS13_2025_EDGE | SecurityPolicy_TLS12_PFS_2025_EDGE | SecurityPolicy_TLS12_2018_EDGE` 

 ** [tags](#API_CreateDomainName_ResponseSyntax) **   <a name="apigw-CreateDomainName-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

## Errors
<a name="API_CreateDomainName_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateDomainName_Examples"></a>

### Create a domain name
<a name="API_CreateDomainName_Example_1"></a>

This example illustrates one usage of CreateDomainName.

#### Sample Request
<a name="API_CreateDomainName_Example_1_Request"></a>

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

{
  "domainName" : "my-api.example.com",
  "certificateName": "my-cert-created-today",
  "certificateArn": "arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3",
  "endpointConfiguration": {
    "types": ["EDGE"]
  }
}
```

#### Sample Response
<a name="API_CreateDomainName_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-basepathmapping-{rel}.html",
        "name": "basepathmapping",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-domainname-{rel}.html",
        "name": "domainname",
        "templated": true
      }
    ],
    "self": {
      "href": "/domainnames/my-api.example.com"
    },
    "basepathmapping:by-base-path": {
      "href": "/domainnames/my-api.example.com/basepathmappings/{base_path}",
      "templated": true
    },
    "basepathmapping:create": {
      "href": "/domainnames/my-api.example.com/basepathmappings"
    },
    "domainname:basepathmappings": {
      "href": "/domainnames/my-api.example.com/basepathmappings{?limit}",
      "templated": true
    },
    "domainname:delete": {
      "href": "/domainnames/my-api.example.com"
    },
    "domainname:update": {
      "href": "/domainnames/my-api.example.com"
    }
  },
  "certificateArn": "arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3",
  "certificateName": "my-cert-created-today",
  "certificateUploadDate": "2016-06-15T21:14:43Z",
  "distributionDomainName": "d2ck2x1vuc8qzh.cloudfront.net",
  "domainName": "my-api.example.com"
}
```

## See Also
<a name="API_CreateDomainName_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateDomainName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateDomainName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateDomainName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateDomainName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateDomainName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateDomainName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateDomainName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateDomainName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateDomainName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateDomainName) 

# CreateDomainNameAccessAssociation
<a name="API_CreateDomainNameAccessAssociation"></a>

 Creates a domain name access association resource between an access association source and a private custom domain name.

## Request Syntax
<a name="API_CreateDomainNameAccessAssociation_RequestSyntax"></a>

```
POST /domainnameaccessassociations HTTP/1.1
Content-type: application/json

{
   "accessAssociationSource": "string",
   "accessAssociationSourceType": "string",
   "domainNameArn": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateDomainNameAccessAssociation_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateDomainNameAccessAssociation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [accessAssociationSource](#API_CreateDomainNameAccessAssociation_RequestSyntax) **   <a name="apigw-CreateDomainNameAccessAssociation-request-accessAssociationSource"></a>
 The identifier of the domain name access association source. For a VPCE, the value is the VPC endpoint ID.   
Type: String  
Required: Yes

 ** [accessAssociationSourceType](#API_CreateDomainNameAccessAssociation_RequestSyntax) **   <a name="apigw-CreateDomainNameAccessAssociation-request-accessAssociationSourceType"></a>
 The type of the domain name access association source.   
Type: String  
Valid Values: `VPCE`   
Required: Yes

 ** [domainNameArn](#API_CreateDomainNameAccessAssociation_RequestSyntax) **   <a name="apigw-CreateDomainNameAccessAssociation-request-domainNameArn"></a>
 The ARN of the domain name.   
Type: String  
Required: Yes

 ** [tags](#API_CreateDomainNameAccessAssociation_RequestSyntax) **   <a name="apigw-CreateDomainNameAccessAssociation-request-tags"></a>
The key-value map of strings. The valid character set is [a-zA-Z\$1-=.\$1:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_CreateDomainNameAccessAssociation_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "accessAssociationSource": "string",
   "accessAssociationSourceType": "string",
   "domainNameAccessAssociationArn": "string",
   "domainNameArn": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_CreateDomainNameAccessAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [accessAssociationSource](#API_CreateDomainNameAccessAssociation_ResponseSyntax) **   <a name="apigw-CreateDomainNameAccessAssociation-response-accessAssociationSource"></a>
 The identifier of the domain name access association source. For a VPCE, the value is the VPC endpoint ID.   
Type: String

 ** [accessAssociationSourceType](#API_CreateDomainNameAccessAssociation_ResponseSyntax) **   <a name="apigw-CreateDomainNameAccessAssociation-response-accessAssociationSourceType"></a>
 The type of the domain name access association source.   
Type: String  
Valid Values: `VPCE` 

 ** [domainNameAccessAssociationArn](#API_CreateDomainNameAccessAssociation_ResponseSyntax) **   <a name="apigw-CreateDomainNameAccessAssociation-response-domainNameAccessAssociationArn"></a>
The ARN of the domain name access association resource.   
Type: String

 ** [domainNameArn](#API_CreateDomainNameAccessAssociation_ResponseSyntax) **   <a name="apigw-CreateDomainNameAccessAssociation-response-domainNameArn"></a>
The ARN of the domain name.   
Type: String

 ** [tags](#API_CreateDomainNameAccessAssociation_ResponseSyntax) **   <a name="apigw-CreateDomainNameAccessAssociation-response-tags"></a>
 The collection of tags. Each tag element is associated with a given resource.   
Type: String to string map

## Errors
<a name="API_CreateDomainNameAccessAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateDomainNameAccessAssociation_Examples"></a>

### Create a domain name access association
<a name="API_CreateDomainNameAccessAssociation_Example_1"></a>

This example illustrates one usage of CreateDomainNameAccessAssociation.

#### Sample Request
<a name="API_CreateDomainNameAccessAssociation_Example_1_Request"></a>

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

{
   "accessAssociationSource": "vpce-abcd1234",
   "accessAssociationSourceType": "VPCE",
   "domainNameArn": "arn:aws:apigateway:us-east-1:012345678910:/domainnames/private.a.b.c.com+abcd1234"
}
```

#### Sample Response
<a name="API_CreateDomainNameAccessAssociation_Example_1_Response"></a>

```
{
    "_links": {
        "curies": {
            "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/domainnameaccessassociation-domainname-{rel}.html",
            "name": "domainnameaccessassociation",
            "templated": true
        },
        "self": {
            "href": "/domainnameaccessassociations?limit=10"
        },
        "domainnameaccessassociation:create": {
            "href": "/domainnameaccessassociations"
        },
        "item": {
            "href": "/domainnameaccessassociations/arn:aws:apigateway:us-east-1:012345678910:/domainnameaccessassociations/domainname/private.a.b.c.com+abcd1234/vpcesource/vpce-abcd1234"
        }
    },
    "_embedded": {
        "item": {
            "_links": {
                "self": {
                    "href": "/domainnameaccessassociations/arn:aws:apigateway:us-east-1:012345678910:/domainnameaccessassociations/domainname/private.a.b.c.com+abcd1234/vpcesource/vpce-abcd1234"
                }
            },
            "accessAssociationSource": "vpce-abcd1234",
            "accessAssociationSourceType": "VPCE",
            "domainNameAccessAssociationArn": "arn:aws:apigateway:us-east-1:012345678910:/domainnameaccessassociations/domainname/private.a.b.c.com+abcd1234/vpcesource/vpce-abcd1234",
            "domainNameArn": "arn:aws:apigateway:us-east-1:012345678910:/domainnames/private.a.b.c.com+abcd1234"
        }
    }
}
```

## See Also
<a name="API_CreateDomainNameAccessAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateDomainNameAccessAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateDomainNameAccessAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateDomainNameAccessAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateDomainNameAccessAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateDomainNameAccessAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateDomainNameAccessAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateDomainNameAccessAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateDomainNameAccessAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateDomainNameAccessAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateDomainNameAccessAssociation) 

# CreateModel
<a name="API_CreateModel"></a>

Adds a new Model resource to an existing RestApi resource.

## Request Syntax
<a name="API_CreateModel_RequestSyntax"></a>

```
POST /restapis/restapi_id/models HTTP/1.1
Content-type: application/json

{
   "contentType": "string",
   "description": "string",
   "name": "string",
   "schema": "string"
}
```

## URI Request Parameters
<a name="API_CreateModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_CreateModel_RequestSyntax) **   <a name="apigw-CreateModel-request-uri-restApiId"></a>
The RestApi identifier under which the Model will be created.  
Required: Yes

## Request Body
<a name="API_CreateModel_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [contentType](#API_CreateModel_RequestSyntax) **   <a name="apigw-CreateModel-request-contentType"></a>
The content-type for the model.  
Type: String  
Required: Yes

 ** [description](#API_CreateModel_RequestSyntax) **   <a name="apigw-CreateModel-request-description"></a>
The description of the model.  
Type: String  
Required: No

 ** [name](#API_CreateModel_RequestSyntax) **   <a name="apigw-CreateModel-request-name"></a>
The name of the model. Must be alphanumeric.  
Type: String  
Required: Yes

 ** [schema](#API_CreateModel_RequestSyntax) **   <a name="apigw-CreateModel-request-schema"></a>
The schema for the model. For `application/json` models, this should be JSON schema draft 4 model. The maximum size of the model is 400 KB.  
Type: String  
Required: No

## Response Syntax
<a name="API_CreateModel_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "contentType": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "schema": "string"
}
```

## Response Elements
<a name="API_CreateModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [contentType](#API_CreateModel_ResponseSyntax) **   <a name="apigw-CreateModel-response-contentType"></a>
The content-type for the model.  
Type: String

 ** [description](#API_CreateModel_ResponseSyntax) **   <a name="apigw-CreateModel-response-description"></a>
The description of the model.  
Type: String

 ** [id](#API_CreateModel_ResponseSyntax) **   <a name="apigw-CreateModel-response-id"></a>
The identifier for the model resource.  
Type: String

 ** [name](#API_CreateModel_ResponseSyntax) **   <a name="apigw-CreateModel-response-name"></a>
The name of the model. Must be an alphanumeric string.  
Type: String

 ** [schema](#API_CreateModel_ResponseSyntax) **   <a name="apigw-CreateModel-response-schema"></a>
The schema for the model. For `application/json` models, this should be JSON schema draft 4 model. Do not include "\$1\$1/" characters in the description of any properties because such "\$1\$1/" 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.  
Type: String

## Errors
<a name="API_CreateModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateModel_Examples"></a>

### Create a model
<a name="API_CreateModel_Example_1"></a>

This example illustrates one usage of CreateModel.

#### Sample Request
<a name="API_CreateModel_Example_1_Request"></a>

```
POST /restapis/uojnr9hd57/models HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160614T173659Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160614/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "name" : "CalcOutput",
  "description" : "Calc output model",
  "schema" : "{\n\t\"title\": \"Calc output\",\n\t\"type\": \"object\",\n\t\"properties\": {\n\t\t\"a\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"b\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"op\": {\n\t\t\t\"description\": \"operation of +, -, * or /\",\n\t\t\t\"type\": \"string\"\n\t\t},\n\t\t\"c\": {\n\t\t    \"type\": \"number\"\n\t\t}\n\t},\n\t\"required\": [\"a\", \"b\", \"op\"]\n}\n",
  "contentType" : "application/json"
}
```

#### Sample Response
<a name="API_CreateModel_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-model-{rel}.html",
      "name": "model",
      "templated": true
    },
    "self": {
      "href": "/restapis/uojnr9hd57/models/CalcOutput?flatten=false"
    },
    "model:create": {
      "href": "/restapis/uojnr9hd57/models"
    },
    "model:delete": {
      "href": "/restapis/uojnr9hd57/models/CalcOutput"
    },
    "model:generate-template": {
      "href": "/restapis/uojnr9hd57/models/CalcOutput/default_template"
    },
    "model:update": {
      "href": "/restapis/uojnr9hd57/models/CalcOutput"
    }
  },
  "contentType": "application/json",
  "description": "Calc output model",
  "id": "mzy1a0",
  "name": "CalcOutput",
  "schema": "{\n\t\"title\": \"Calc output\",\n\t\"type\": \"object\",\n\t\"properties\": {\n\t\t\"a\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"b\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"op\": {\n\t\t\t\"description\": \"operation of +, -, * or /\",\n\t\t\t\"type\": \"string\"\n\t\t},\n\t\t\"c\": {\n\t\t    \"type\": \"number\"\n\t\t}\n\t},\n\t\"required\": [\"a\", \"b\", \"op\"]\n}\n"
}
```

## See Also
<a name="API_CreateModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateModel) 

# CreateRequestValidator
<a name="API_CreateRequestValidator"></a>

Creates a RequestValidator of a given RestApi.

## Request Syntax
<a name="API_CreateRequestValidator_RequestSyntax"></a>

```
POST /restapis/restapi_id/requestvalidators HTTP/1.1
Content-type: application/json

{
   "name": "string",
   "validateRequestBody": boolean,
   "validateRequestParameters": boolean
}
```

## URI Request Parameters
<a name="API_CreateRequestValidator_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_CreateRequestValidator_RequestSyntax) **   <a name="apigw-CreateRequestValidator-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_CreateRequestValidator_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [name](#API_CreateRequestValidator_RequestSyntax) **   <a name="apigw-CreateRequestValidator-request-name"></a>
The name of the to-be-created RequestValidator.  
Type: String  
Required: No

 ** [validateRequestBody](#API_CreateRequestValidator_RequestSyntax) **   <a name="apigw-CreateRequestValidator-request-validateRequestBody"></a>
A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (`true`) or not (`false`).  
Type: Boolean  
Required: No

 ** [validateRequestParameters](#API_CreateRequestValidator_RequestSyntax) **   <a name="apigw-CreateRequestValidator-request-validateRequestParameters"></a>
A Boolean flag to indicate whether to validate request parameters, `true`, or not `false`.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_CreateRequestValidator_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "id": "string",
   "name": "string",
   "validateRequestBody": boolean,
   "validateRequestParameters": boolean
}
```

## Response Elements
<a name="API_CreateRequestValidator_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [id](#API_CreateRequestValidator_ResponseSyntax) **   <a name="apigw-CreateRequestValidator-response-id"></a>
The identifier of this RequestValidator.  
Type: String

 ** [name](#API_CreateRequestValidator_ResponseSyntax) **   <a name="apigw-CreateRequestValidator-response-name"></a>
The name of this RequestValidator  
Type: String

 ** [validateRequestBody](#API_CreateRequestValidator_ResponseSyntax) **   <a name="apigw-CreateRequestValidator-response-validateRequestBody"></a>
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.  
Type: Boolean

 ** [validateRequestParameters](#API_CreateRequestValidator_ResponseSyntax) **   <a name="apigw-CreateRequestValidator-response-validateRequestParameters"></a>
A Boolean flag to indicate whether to validate request parameters (`true`) or not (`false`).  
Type: Boolean

## Errors
<a name="API_CreateRequestValidator_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateRequestValidator_Examples"></a>

### Create a RequestValidator for an API to validate required request payloads
<a name="API_CreateRequestValidator_Example_1"></a>

This example illustrates one usage of CreateRequestValidator.

#### Sample Request
<a name="API_CreateRequestValidator_Example_1_Request"></a>

```
POST /restapis/mkhqppt4e4/requestvalidators HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T172652Z
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}

{
  "name" : "body-only",
  "validateRequestBody" : "true",
  "validateRequestParameters" : "false"
}
```

#### Sample Response
<a name="API_CreateRequestValidator_Example_1_Response"></a>

```
{
  "_links": {
    "self": {
      "href": "/restapis/mkhqppt4e4/requestvalidators/3n5aa0"
    },
    "request-validator-delete": {
      "href": "/restapis/mkhqppt4e4/requestvalidators/3n5aa0"
    },
    "request-validator-update": {
      "href": "/restapis/mkhqppt4e4/requestvalidators/3n5aa0"
    }
  },
  "id": "3n5aa0",
  "name": "body-only",
  "validateRequestBody": true,
  "validateRequestParameters": false
}
```

## See Also
<a name="API_CreateRequestValidator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateRequestValidator) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateRequestValidator) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateRequestValidator) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateRequestValidator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateRequestValidator) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateRequestValidator) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateRequestValidator) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateRequestValidator) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateRequestValidator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateRequestValidator) 

# CreateResource
<a name="API_CreateResource"></a>

Creates a Resource resource.

## Request Syntax
<a name="API_CreateResource_RequestSyntax"></a>

```
POST /restapis/restapi_id/resources/parent_id HTTP/1.1
Content-type: application/json

{
   "pathPart": "string"
}
```

## URI Request Parameters
<a name="API_CreateResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [parent\$1id](#API_CreateResource_RequestSyntax) **   <a name="apigw-CreateResource-request-uri-parentId"></a>
The parent resource's identifier.  
Required: Yes

 ** [restapi\$1id](#API_CreateResource_RequestSyntax) **   <a name="apigw-CreateResource-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_CreateResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [pathPart](#API_CreateResource_RequestSyntax) **   <a name="apigw-CreateResource-request-pathPart"></a>
The last path segment for this resource.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_CreateResource_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "id": "string",
   "parentId": "string",
   "path": "string",
   "pathPart": "string",
   "resourceMethods": { 
      "string" : { 
         "apiKeyRequired": boolean,
         "authorizationScopes": [ "string" ],
         "authorizationType": "string",
         "authorizerId": "string",
         "httpMethod": "string",
         "methodIntegration": { 
            "cacheKeyParameters": [ "string" ],
            "cacheNamespace": "string",
            "connectionId": "string",
            "connectionType": "string",
            "contentHandling": "string",
            "credentials": "string",
            "httpMethod": "string",
            "integrationResponses": { 
               "string" : { 
                  "contentHandling": "string",
                  "responseParameters": { 
                     "string" : "string" 
                  },
                  "responseTemplates": { 
                     "string" : "string" 
                  },
                  "selectionPattern": "string",
                  "statusCode": "string"
               }
            },
            "integrationTarget": "string",
            "passthroughBehavior": "string",
            "requestParameters": { 
               "string" : "string" 
            },
            "requestTemplates": { 
               "string" : "string" 
            },
            "responseTransferMode": "string",
            "timeoutInMillis": number,
            "tlsConfig": { 
               "insecureSkipVerification": boolean
            },
            "type": "string",
            "uri": "string"
         },
         "methodResponses": { 
            "string" : { 
               "responseModels": { 
                  "string" : "string" 
               },
               "responseParameters": { 
                  "string" : boolean 
               },
               "statusCode": "string"
            }
         },
         "operationName": "string",
         "requestModels": { 
            "string" : "string" 
         },
         "requestParameters": { 
            "string" : boolean 
         },
         "requestValidatorId": "string"
      }
   }
}
```

## Response Elements
<a name="API_CreateResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [id](#API_CreateResource_ResponseSyntax) **   <a name="apigw-CreateResource-response-id"></a>
The resource's identifier.  
Type: String

 ** [parentId](#API_CreateResource_ResponseSyntax) **   <a name="apigw-CreateResource-response-parentId"></a>
The parent resource's identifier.  
Type: String

 ** [path](#API_CreateResource_ResponseSyntax) **   <a name="apigw-CreateResource-response-path"></a>
The full path for this resource.  
Type: String

 ** [pathPart](#API_CreateResource_ResponseSyntax) **   <a name="apigw-CreateResource-response-pathPart"></a>
The last path segment for this resource.  
Type: String

 ** [resourceMethods](#API_CreateResource_ResponseSyntax) **   <a name="apigw-CreateResource-response-resourceMethods"></a>
Gets an API resource's method of a given HTTP verb.  
Type: String to [Method](API_Method.md) object map

## Errors
<a name="API_CreateResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateResource_Examples"></a>

### Create a child resource under an API's root resource
<a name="API_CreateResource_Example_1"></a>

This example illustrates one usage of CreateResource.

#### Sample Request
<a name="API_CreateResource_Example_1_Request"></a>

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

{
    "pathPart" : "res1"
}
```

#### Sample Response
<a name="API_CreateResource_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
        "name": "method",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-resource-{rel}.html",
        "name": "resource",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis/fugvjdxtri/resources/47rxl6"
    },
    "method:by-http-method": {
      "href": "/restapis/fugvjdxtri/resources/47rxl6/methods/{http_method}",
      "templated": true
    },
    "method:put": {
      "href": "/restapis/fugvjdxtri/resources/47rxl6/methods/{http_method}",
      "templated": true
    },
    "resource:create-child": {
      "href": "/restapis/fugvjdxtri/resources/47rxl6"
    },
    "resource:delete": {
      "href": "/restapis/fugvjdxtri/resources/47rxl6"
    },
    "resource:update": {
      "href": "/restapis/fugvjdxtri/resources/47rxl6"
    }
  },
  "id": "47rxl6",
  "parentId": "3kzxbg5sa2",
  "path": "/res1",
  "pathPart": "res1"
}
```

## See Also
<a name="API_CreateResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateResource) 

# CreateRestApi
<a name="API_CreateRestApi"></a>

Creates a new RestApi resource.

## Request Syntax
<a name="API_CreateRestApi_RequestSyntax"></a>

```
POST /restapis HTTP/1.1
Content-type: application/json

{
   "apiKeySource": "string",
   "binaryMediaTypes": [ "string" ],
   "cloneFrom": "string",
   "description": "string",
   "disableExecuteApiEndpoint": boolean,
   "endpointAccessMode": "string",
   "endpointConfiguration": { 
      "ipAddressType": "string",
      "types": [ "string" ],
      "vpcEndpointIds": [ "string" ]
   },
   "minimumCompressionSize": number,
   "name": "string",
   "policy": "string",
   "securityPolicy": "string",
   "tags": { 
      "string" : "string" 
   },
   "version": "string"
}
```

## URI Request Parameters
<a name="API_CreateRestApi_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateRestApi_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [apiKeySource](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-apiKeySource"></a>
The source of the API key for metering requests according to a usage plan. Valid values are: `HEADER` to read the API key from the `X-API-Key` header of a request. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer.  
Type: String  
Valid Values: `HEADER | AUTHORIZER`   
Required: No

 ** [binaryMediaTypes](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-binaryMediaTypes"></a>
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.  
Type: Array of strings  
Required: No

 ** [cloneFrom](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-cloneFrom"></a>
The ID of the RestApi that you want to clone from.  
Type: String  
Required: No

 ** [description](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-description"></a>
The description of the RestApi.  
Type: String  
Required: No

 ** [disableExecuteApiEndpoint](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-disableExecuteApiEndpoint"></a>
Specifies whether clients can invoke your API by using the default `execute-api` endpoint. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint  
Type: Boolean  
Required: No

 ** [endpointAccessMode](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-endpointAccessMode"></a>
 The endpoint access mode of the RestApi. Only available for RestApis that use security policies that start with `SecurityPolicy_`.  
Type: String  
Valid Values: `BASIC | STRICT`   
Required: No

 ** [endpointConfiguration](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-endpointConfiguration"></a>
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.   
Type: [EndpointConfiguration](API_EndpointConfiguration.md) object  
Required: No

 ** [minimumCompressionSize](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-minimumCompressionSize"></a>
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.  
Type: Integer  
Required: No

 ** [name](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-name"></a>
The name of the RestApi.  
Type: String  
Required: Yes

 ** [policy](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-policy"></a>
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.  
Type: String  
Required: No

 ** [securityPolicy](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-securityPolicy"></a>
 The Transport Layer Security (TLS) version \$1 cipher suite for this RestApi.   
Type: String  
Valid Values: `TLS_1_0 | TLS_1_2 | SecurityPolicy_TLS13_1_3_2025_09 | SecurityPolicy_TLS13_1_3_FIPS_2025_09 | SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_PQ_2025_09 | SecurityPolicy_TLS13_1_2_2021_06 | SecurityPolicy_TLS13_2025_EDGE | SecurityPolicy_TLS12_PFS_2025_EDGE | SecurityPolicy_TLS12_2018_EDGE`   
Required: No

 ** [tags](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-tags"></a>
The key-value map of strings. The valid character set is [a-zA-Z\$1-=.\$1:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.  
Type: String to string map  
Required: No

 ** [version](#API_CreateRestApi_RequestSyntax) **   <a name="apigw-CreateRestApi-request-version"></a>
A version identifier for the API.  
Type: String  
Required: No

## Response Syntax
<a name="API_CreateRestApi_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "apiKeySource": "string",
   "apiStatus": "string",
   "apiStatusMessage": "string",
   "binaryMediaTypes": [ "string" ],
   "createdDate": number,
   "description": "string",
   "disableExecuteApiEndpoint": boolean,
   "endpointAccessMode": "string",
   "endpointConfiguration": { 
      "ipAddressType": "string",
      "types": [ "string" ],
      "vpcEndpointIds": [ "string" ]
   },
   "id": "string",
   "minimumCompressionSize": number,
   "name": "string",
   "policy": "string",
   "rootResourceId": "string",
   "securityPolicy": "string",
   "tags": { 
      "string" : "string" 
   },
   "version": "string",
   "warnings": [ "string" ]
}
```

## Response Elements
<a name="API_CreateRestApi_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [apiKeySource](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-apiKeySource"></a>
The source of the API key for metering requests according to a usage plan. Valid values are: >`HEADER` to read the API key from the `X-API-Key` header of a request. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer.  
Type: String  
Valid Values: `HEADER | AUTHORIZER` 

 ** [apiStatus](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-apiStatus"></a>
The ApiStatus of the RestApi.   
Type: String  
Valid Values: `UPDATING | AVAILABLE | PENDING | FAILED` 

 ** [apiStatusMessage](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-apiStatusMessage"></a>
 The status message of the RestApi. When the status message is `UPDATING` you can still invoke it.   
Type: String

 ** [binaryMediaTypes](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-binaryMediaTypes"></a>
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.  
Type: Array of strings

 ** [createdDate](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-createdDate"></a>
The timestamp when the API was created.  
Type: Timestamp

 ** [description](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-description"></a>
The API's description.  
Type: String

 ** [disableExecuteApiEndpoint](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-disableExecuteApiEndpoint"></a>
Specifies whether clients can invoke your API by using the default `execute-api` endpoint. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.  
Type: Boolean

 ** [endpointAccessMode](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-endpointAccessMode"></a>
 The endpoint access mode of the RestApi.   
Type: String  
Valid Values: `BASIC | STRICT` 

 ** [endpointConfiguration](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-endpointConfiguration"></a>
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.   
Type: [EndpointConfiguration](API_EndpointConfiguration.md) object

 ** [id](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-id"></a>
The API's identifier. This identifier is unique across all of your APIs in API Gateway.  
Type: String

 ** [minimumCompressionSize](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-minimumCompressionSize"></a>
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.  
Type: Integer

 ** [name](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-name"></a>
The API's name.  
Type: String

 ** [policy](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-policy"></a>
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.  
Type: String

 ** [rootResourceId](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-rootResourceId"></a>
The API's root resource ID.  
Type: String

 ** [securityPolicy](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-securityPolicy"></a>
 The Transport Layer Security (TLS) version \$1 cipher suite for this RestApi.   
Type: String  
Valid Values: `TLS_1_0 | TLS_1_2 | SecurityPolicy_TLS13_1_3_2025_09 | SecurityPolicy_TLS13_1_3_FIPS_2025_09 | SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_PQ_2025_09 | SecurityPolicy_TLS13_1_2_2021_06 | SecurityPolicy_TLS13_2025_EDGE | SecurityPolicy_TLS12_PFS_2025_EDGE | SecurityPolicy_TLS12_2018_EDGE` 

 ** [tags](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [version](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-version"></a>
A version identifier for the API.  
Type: String

 ** [warnings](#API_CreateRestApi_ResponseSyntax) **   <a name="apigw-CreateRestApi-response-warnings"></a>
The warning messages reported when `failonwarnings` is turned on during API import.  
Type: Array of strings

## Errors
<a name="API_CreateRestApi_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateRestApi_Examples"></a>

### Create a new API
<a name="API_CreateRestApi_Example_1"></a>

This example illustrates one usage of CreateRestApi.

#### Sample Request
<a name="API_CreateRestApi_Example_1_Request"></a>

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

{
    "name" : "my-test-api",
    "description" : "A sample API created programmatically by calling API Gateway control service using the REST API"
}
```

#### Sample Response
<a name="API_CreateRestApi_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
       ...
    ],
    "self": {
      "href": "/restapis/fugvjdxtri"
    },
    "authorizer:by-id": {
      "href": "/restapis/fugvjdxtri/authorizers/{authorizer_id}",
      "templated": true
    },
    "authorizer:create": {
      "href": "/restapis/fugvjdxtri/authorizers"
    },
    "deployment:by-id": {
      "href": "/restapis/fugvjdxtri/deployments/{deployment_id}{?embed}",
      "templated": true
    },
    "deployment:create": {
      "href": "/restapis/fugvjdxtri/deployments"
    },
    "model:by-name": {
      "href": "/restapis/fugvjdxtri/models/{model_name}?flatten=false",
      "templated": true
    },
    "model:create": {
      "href": "/restapis/fugvjdxtri/models"
    },
    "resource:by-id": {
      "href": "/restapis/fugvjdxtri/resources/{resource_id}{?embed}",
      "templated": true
    },
    "resource:create": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2"
    },
    "restapi:authorizers": {
      "href": "/restapis/fugvjdxtri/authorizers"
    },
    "restapi:delete": {
      "href": "/restapis/fugvjdxtri"
    },
    "restapi:deployments": {
      "href": "/restapis/fugvjdxtri/deployments{?limit}",
      "templated": true
    },
    "restapi:models": {
      "href": "/restapis/fugvjdxtri/models"
    },
    "restapi:resources": {
      "href": "/restapis/fugvjdxtri/resources{?limit,embed}",
      "templated": true
    },
    "restapi:stages": {
      "href": "/restapis/fugvjdxtri/stages{?deployment_id}",
      "templated": true
    },
    "restapi:update": {
      "href": "/restapis/fugvjdxtri"
    },
    "stage:by-name": {
      "href": "/restapis/fugvjdxtri/stages/{stage_name}",
      "templated": true
    },
    "stage:create": {
      "href": "/restapis/fugvjdxtri/stages"
    }
  },
  "createdDate": "2016-06-01T18:53:41Z",
  "description": "A sample API created programmatically by calling API Gateway control service using the REST API",
  "id": "fugvjdxtri",
  "name": "my-test-api"
}
```

## See Also
<a name="API_CreateRestApi_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateRestApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateRestApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateRestApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateRestApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateRestApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateRestApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateRestApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateRestApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateRestApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateRestApi) 

# CreateStage
<a name="API_CreateStage"></a>

Creates a new Stage resource that references a pre-existing Deployment for the API. 

## Request Syntax
<a name="API_CreateStage_RequestSyntax"></a>

```
POST /restapis/restapi_id/stages HTTP/1.1
Content-type: application/json

{
   "cacheClusterEnabled": boolean,
   "cacheClusterSize": "string",
   "canarySettings": { 
      "deploymentId": "string",
      "percentTraffic": number,
      "stageVariableOverrides": { 
         "string" : "string" 
      },
      "useStageCache": boolean
   },
   "deploymentId": "string",
   "description": "string",
   "documentationVersion": "string",
   "stageName": "string",
   "tags": { 
      "string" : "string" 
   },
   "tracingEnabled": boolean,
   "variables": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateStage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_CreateStage_RequestSyntax) **   <a name="apigw-CreateStage-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_CreateStage_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [cacheClusterEnabled](#API_CreateStage_RequestSyntax) **   <a name="apigw-CreateStage-request-cacheClusterEnabled"></a>
Whether cache clustering is enabled for the stage.  
Type: Boolean  
Required: No

 ** [cacheClusterSize](#API_CreateStage_RequestSyntax) **   <a name="apigw-CreateStage-request-cacheClusterSize"></a>
The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).  
Type: String  
Valid Values: `0.5 | 1.6 | 6.1 | 13.5 | 28.4 | 58.2 | 118 | 237`   
Required: No

 ** [canarySettings](#API_CreateStage_RequestSyntax) **   <a name="apigw-CreateStage-request-canarySettings"></a>
The canary deployment settings of this stage.  
Type: [CanarySettings](API_CanarySettings.md) object  
Required: No

 ** [deploymentId](#API_CreateStage_RequestSyntax) **   <a name="apigw-CreateStage-request-deploymentId"></a>
The identifier of the Deployment resource for the Stage resource.  
Type: String  
Required: Yes

 ** [description](#API_CreateStage_RequestSyntax) **   <a name="apigw-CreateStage-request-description"></a>
The description of the Stage resource.  
Type: String  
Required: No

 ** [documentationVersion](#API_CreateStage_RequestSyntax) **   <a name="apigw-CreateStage-request-documentationVersion"></a>
The version of the associated API documentation.  
Type: String  
Required: No

 ** [stageName](#API_CreateStage_RequestSyntax) **   <a name="apigw-CreateStage-request-stageName"></a>
The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.  
Type: String  
Required: Yes

 ** [tags](#API_CreateStage_RequestSyntax) **   <a name="apigw-CreateStage-request-tags"></a>
The key-value map of strings. The valid character set is [a-zA-Z\$1-=.\$1:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.  
Type: String to string map  
Required: No

 ** [tracingEnabled](#API_CreateStage_RequestSyntax) **   <a name="apigw-CreateStage-request-tracingEnabled"></a>
Specifies whether active tracing with X-ray is enabled for the Stage.  
Type: Boolean  
Required: No

 ** [variables](#API_CreateStage_RequestSyntax) **   <a name="apigw-CreateStage-request-variables"></a>
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-._~:/?#&=,]+`.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_CreateStage_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "accessLogSettings": { 
      "destinationArn": "string",
      "format": "string"
   },
   "cacheClusterEnabled": boolean,
   "cacheClusterSize": "string",
   "cacheClusterStatus": "string",
   "canarySettings": { 
      "deploymentId": "string",
      "percentTraffic": number,
      "stageVariableOverrides": { 
         "string" : "string" 
      },
      "useStageCache": boolean
   },
   "clientCertificateId": "string",
   "createdDate": number,
   "deploymentId": "string",
   "description": "string",
   "documentationVersion": "string",
   "lastUpdatedDate": number,
   "methodSettings": { 
      "string" : { 
         "cacheDataEncrypted": boolean,
         "cacheTtlInSeconds": number,
         "cachingEnabled": boolean,
         "dataTraceEnabled": boolean,
         "loggingLevel": "string",
         "metricsEnabled": boolean,
         "requireAuthorizationForCacheControl": boolean,
         "throttlingBurstLimit": number,
         "throttlingRateLimit": number,
         "unauthorizedCacheControlHeaderStrategy": "string"
      }
   },
   "stageName": "string",
   "tags": { 
      "string" : "string" 
   },
   "tracingEnabled": boolean,
   "variables": { 
      "string" : "string" 
   },
   "webAclArn": "string"
}
```

## Response Elements
<a name="API_CreateStage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [accessLogSettings](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-accessLogSettings"></a>
Settings for logging access in this stage.  
Type: [AccessLogSettings](API_AccessLogSettings.md) object

 ** [cacheClusterEnabled](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-cacheClusterEnabled"></a>
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set `CachingEnabled` to `true` for a method.   
Type: Boolean

 ** [cacheClusterSize](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-cacheClusterSize"></a>
The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).  
Type: String  
Valid Values: `0.5 | 1.6 | 6.1 | 13.5 | 28.4 | 58.2 | 118 | 237` 

 ** [cacheClusterStatus](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-cacheClusterStatus"></a>
The status of the cache cluster for the stage, if enabled.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | AVAILABLE | DELETE_IN_PROGRESS | NOT_AVAILABLE | FLUSH_IN_PROGRESS` 

 ** [canarySettings](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-canarySettings"></a>
Settings for the canary deployment in this stage.  
Type: [CanarySettings](API_CanarySettings.md) object

 ** [clientCertificateId](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-clientCertificateId"></a>
The identifier of a client certificate for an API stage.  
Type: String

 ** [createdDate](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-createdDate"></a>
The timestamp when the stage was created.  
Type: Timestamp

 ** [deploymentId](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-deploymentId"></a>
The identifier of the Deployment that the stage points to.  
Type: String

 ** [description](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-description"></a>
The stage's description.  
Type: String

 ** [documentationVersion](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-documentationVersion"></a>
The version of the associated API documentation.  
Type: String

 ** [lastUpdatedDate](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-lastUpdatedDate"></a>
The timestamp when the stage last updated.  
Type: Timestamp

 ** [methodSettings](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-methodSettings"></a>
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.   
Type: String to [MethodSetting](API_MethodSetting.md) object map

 ** [stageName](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-stageName"></a>
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.  
Type: String

 ** [tags](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [tracingEnabled](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-tracingEnabled"></a>
Specifies whether active tracing with X-ray is enabled for the Stage.  
Type: Boolean

 ** [variables](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-variables"></a>
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-._~:/?#&=,]+`.  
Type: String to string map

 ** [webAclArn](#API_CreateStage_ResponseSyntax) **   <a name="apigw-CreateStage-response-webAclArn"></a>
The ARN of the WebAcl associated with the Stage.  
Type: String

## Errors
<a name="API_CreateStage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateStage_Examples"></a>

### Create a new stage for a deployed API
<a name="API_CreateStage_Example_1"></a>

This example illustrates one usage of CreateStage.

#### Sample Request
<a name="API_CreateStage_Example_1_Request"></a>

```
POST /restapis/uycll6xg9a/stages HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T200249Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "stageName" : "alpha",
  "deploymentId" : "vakw79",
  "description" : "alpha stage",
  "cacheClusterEnabled" : "true",
  "cacheClusterSize" : "0.5",
  "variables" : {
    "sv_1" : "value_1",
    "sv_2" : "value_2"
  }
}
```

#### Sample Response
<a name="API_CreateStage_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-stage-{rel}.html",
      "name": "stage",
      "templated": true
    },
    "self": {
      "href": "/restapis/uycll6xg9a/stages/alpha"
    },
    "stage:delete": {
      "href": "/restapis/uycll6xg9a/stages/alpha"
    },
    "stage:flush-authorizer-cache": {
      "href": "/restapis/uycll6xg9a/stages/alpha/cache/authorizers"
    },
    "stage:flush-cache": {
      "href": "/restapis/uycll6xg9a/stages/alpha/cache/data"
    },
    "stage:update": {
      "href": "/restapis/uycll6xg9a/stages/alpha"
    }
  },
  "cacheClusterEnabled": true,
  "cacheClusterSize": "0.5",
  "cacheClusterStatus": "CREATE_IN_PROGRESS",
  "createdDate": "2016-06-08T20:02:50Z",
  "deploymentId": "vakw79",
  "description": "alpha stage",
  "lastUpdatedDate": "2016-06-08T20:02:50Z",
  "methodSettings": {},
  "stageName": "alpha",
  "variables": {
    "sv_2": "value_2",
    "sv_1": "value_1"
  }
}
```

## See Also
<a name="API_CreateStage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateStage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateStage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateStage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateStage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateStage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateStage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateStage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateStage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateStage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateStage) 

# CreateUsagePlan
<a name="API_CreateUsagePlan"></a>

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. 

## Request Syntax
<a name="API_CreateUsagePlan_RequestSyntax"></a>

```
POST /usageplans HTTP/1.1
Content-type: application/json

{
   "apiStages": [ 
      { 
         "apiId": "string",
         "stage": "string",
         "throttle": { 
            "string" : { 
               "burstLimit": number,
               "rateLimit": number
            }
         }
      }
   ],
   "description": "string",
   "name": "string",
   "quota": { 
      "limit": number,
      "offset": number,
      "period": "string"
   },
   "tags": { 
      "string" : "string" 
   },
   "throttle": { 
      "burstLimit": number,
      "rateLimit": number
   }
}
```

## URI Request Parameters
<a name="API_CreateUsagePlan_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateUsagePlan_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [apiStages](#API_CreateUsagePlan_RequestSyntax) **   <a name="apigw-CreateUsagePlan-request-apiStages"></a>
The associated API stages of the usage plan.  
Type: Array of [ApiStage](API_ApiStage.md) objects  
Required: No

 ** [description](#API_CreateUsagePlan_RequestSyntax) **   <a name="apigw-CreateUsagePlan-request-description"></a>
The description of the usage plan.  
Type: String  
Required: No

 ** [name](#API_CreateUsagePlan_RequestSyntax) **   <a name="apigw-CreateUsagePlan-request-name"></a>
The name of the usage plan.  
Type: String  
Required: Yes

 ** [quota](#API_CreateUsagePlan_RequestSyntax) **   <a name="apigw-CreateUsagePlan-request-quota"></a>
The quota of the usage plan.  
Type: [QuotaSettings](API_QuotaSettings.md) object  
Required: No

 ** [tags](#API_CreateUsagePlan_RequestSyntax) **   <a name="apigw-CreateUsagePlan-request-tags"></a>
The key-value map of strings. The valid character set is [a-zA-Z\$1-=.\$1:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.  
Type: String to string map  
Required: No

 ** [throttle](#API_CreateUsagePlan_RequestSyntax) **   <a name="apigw-CreateUsagePlan-request-throttle"></a>
The throttling limits of the usage plan.  
Type: [ThrottleSettings](API_ThrottleSettings.md) object  
Required: No

## Response Syntax
<a name="API_CreateUsagePlan_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "apiStages": [ 
      { 
         "apiId": "string",
         "stage": "string",
         "throttle": { 
            "string" : { 
               "burstLimit": number,
               "rateLimit": number
            }
         }
      }
   ],
   "description": "string",
   "id": "string",
   "name": "string",
   "productCode": "string",
   "quota": { 
      "limit": number,
      "offset": number,
      "period": "string"
   },
   "tags": { 
      "string" : "string" 
   },
   "throttle": { 
      "burstLimit": number,
      "rateLimit": number
   }
}
```

## Response Elements
<a name="API_CreateUsagePlan_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [apiStages](#API_CreateUsagePlan_ResponseSyntax) **   <a name="apigw-CreateUsagePlan-response-apiStages"></a>
The associated API stages of a usage plan.  
Type: Array of [ApiStage](API_ApiStage.md) objects

 ** [description](#API_CreateUsagePlan_ResponseSyntax) **   <a name="apigw-CreateUsagePlan-response-description"></a>
The description of a usage plan.  
Type: String

 ** [id](#API_CreateUsagePlan_ResponseSyntax) **   <a name="apigw-CreateUsagePlan-response-id"></a>
The identifier of a UsagePlan resource.  
Type: String

 ** [name](#API_CreateUsagePlan_ResponseSyntax) **   <a name="apigw-CreateUsagePlan-response-name"></a>
The name of a usage plan.  
Type: String

 ** [productCode](#API_CreateUsagePlan_ResponseSyntax) **   <a name="apigw-CreateUsagePlan-response-productCode"></a>
The AWS Marketplace product identifier to associate with the usage plan as a SaaS product on the AWS Marketplace.  
Type: String

 ** [quota](#API_CreateUsagePlan_ResponseSyntax) **   <a name="apigw-CreateUsagePlan-response-quota"></a>
The target maximum number of permitted requests per a given unit time interval.  
Type: [QuotaSettings](API_QuotaSettings.md) object

 ** [tags](#API_CreateUsagePlan_ResponseSyntax) **   <a name="apigw-CreateUsagePlan-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [throttle](#API_CreateUsagePlan_ResponseSyntax) **   <a name="apigw-CreateUsagePlan-response-throttle"></a>
A map containing method level throttling information for API stage in a usage plan.  
Type: [ThrottleSettings](API_ThrottleSettings.md) object

## Errors
<a name="API_CreateUsagePlan_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateUsagePlan_Examples"></a>

### Create a usage plan
<a name="API_CreateUsagePlan_Example_1"></a>

This example illustrates one usage of CreateUsagePlan.

#### Sample Request
<a name="API_CreateUsagePlan_Example_1_Request"></a>

```
POST /usageplans HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160805T013511Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160805/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sigv4_hash}
Cache-Control: no-cache
Postman-Token: c3ffa588-50e0-aa0c-234e-f191671564a9

{
  "name": "Plan_G",
  "description": "my plan",
  "apiStages": [ {
    "stage": "testStage",
    "apiId": "kdwpu39c2k"
  }],
  "quota": {
    "period": "DAY",
    "offset": 0,
    "limit": 500
  },
  "throttle": {
    "rateLimit": 100,
    "burstLimit": 200
  }
}
```

#### Sample Response
<a name="API_CreateUsagePlan_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usage-{rel}.html",
        "name": "usage",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usageplan-{rel}.html",
        "name": "usageplan",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usageplankey-{rel}.html",
        "name": "usageplankey",
        "templated": true
      }
    ],
    "self": {
      "href": "/usageplans/1puccm"
    },
    "usage:get": {
      "href": "/usageplans/1puccm/usage?startDate=2016-07-06&endDate=2016-08-05"
    },
    "usageplan:delete": {
      "href": "/usageplans/1puccm"
    },
    "usageplan:update": {
      "href": "/usageplans/1puccm"
    },
    "usageplan:usageplankeys": {
      "href": "/usageplans/1puccm/keys"
    },
    "usageplankey:create": {
      "href": "/usageplans/1puccm/keys"
    }
  },
  "apiStages": {
    "stage": "testStage",
    "apiId": "kdwpu39c2k"
  },
  "description": "my plan",
  "id": "1puccm",
  "name": "Plan_G",
  "quota": {
    "period": "DAY",
    "offset": 0,
    "limit": 500
  },
  "throttle": {
    "rateLimit": 100,
    "burstLimit": 200
  }
}
```

## See Also
<a name="API_CreateUsagePlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateUsagePlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateUsagePlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateUsagePlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateUsagePlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateUsagePlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateUsagePlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateUsagePlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateUsagePlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateUsagePlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateUsagePlan) 

# CreateUsagePlanKey
<a name="API_CreateUsagePlanKey"></a>

Creates a usage plan key for adding an existing API key to a usage plan.

## Request Syntax
<a name="API_CreateUsagePlanKey_RequestSyntax"></a>

```
POST /usageplans/usageplanId/keys HTTP/1.1
Content-type: application/json

{
   "keyId": "string",
   "keyType": "string"
}
```

## URI Request Parameters
<a name="API_CreateUsagePlanKey_RequestParameters"></a>

The request uses the following URI parameters.

 ** [usageplanId](#API_CreateUsagePlanKey_RequestSyntax) **   <a name="apigw-CreateUsagePlanKey-request-uri-usagePlanId"></a>
The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.  
Required: Yes

## Request Body
<a name="API_CreateUsagePlanKey_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [keyId](#API_CreateUsagePlanKey_RequestSyntax) **   <a name="apigw-CreateUsagePlanKey-request-keyId"></a>
The identifier of a UsagePlanKey resource for a plan customer.  
Type: String  
Required: Yes

 ** [keyType](#API_CreateUsagePlanKey_RequestSyntax) **   <a name="apigw-CreateUsagePlanKey-request-keyType"></a>
The type of a UsagePlanKey resource for a plan customer.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_CreateUsagePlanKey_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "id": "string",
   "name": "string",
   "type": "string",
   "value": "string"
}
```

## Response Elements
<a name="API_CreateUsagePlanKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [id](#API_CreateUsagePlanKey_ResponseSyntax) **   <a name="apigw-CreateUsagePlanKey-response-id"></a>
The Id of a usage plan key.  
Type: String

 ** [name](#API_CreateUsagePlanKey_ResponseSyntax) **   <a name="apigw-CreateUsagePlanKey-response-name"></a>
The name of a usage plan key.  
Type: String

 ** [type](#API_CreateUsagePlanKey_ResponseSyntax) **   <a name="apigw-CreateUsagePlanKey-response-type"></a>
The type of a usage plan key. Currently, the valid key type is `API_KEY`.  
Type: String

 ** [value](#API_CreateUsagePlanKey_ResponseSyntax) **   <a name="apigw-CreateUsagePlanKey-response-value"></a>
The value of a usage plan key.  
Type: String

## Errors
<a name="API_CreateUsagePlanKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateUsagePlanKey_Examples"></a>

### Create a usage plan key
<a name="API_CreateUsagePlanKey_Example_1"></a>

This example illustrates one usage of CreateUsagePlanKey.

#### Sample Request
<a name="API_CreateUsagePlanKey_Example_1_Request"></a>

```
POST /usageplans/n371pt/keys HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160805T181755Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160805/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sigv4_hash}

{
    "keyId": "q5ugs7qjjh",
    "keyType": "API_KEY"
}
```

#### Sample Response
<a name="API_CreateUsagePlanKey_Example_1_Response"></a>

```
{
  "_links": {
    "self": {
      "href": "/usageplans/n371pt/keys/q5ugs7qjjh"
    }
  },
  "id": "q5ugs7qjjh",
  "name": " importedKey_2",
  "type": "API_KEY"
}
```

## See Also
<a name="API_CreateUsagePlanKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateUsagePlanKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateUsagePlanKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateUsagePlanKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateUsagePlanKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateUsagePlanKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateUsagePlanKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateUsagePlanKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateUsagePlanKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateUsagePlanKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateUsagePlanKey) 

# CreateVpcLink
<a name="API_CreateVpcLink"></a>

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.

## Request Syntax
<a name="API_CreateVpcLink_RequestSyntax"></a>

```
POST /vpclinks HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetArns": [ "string" ]
}
```

## URI Request Parameters
<a name="API_CreateVpcLink_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateVpcLink_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_CreateVpcLink_RequestSyntax) **   <a name="apigw-CreateVpcLink-request-description"></a>
The description of the VPC link.  
Type: String  
Required: No

 ** [name](#API_CreateVpcLink_RequestSyntax) **   <a name="apigw-CreateVpcLink-request-name"></a>
The name used to label and identify the VPC link.  
Type: String  
Required: Yes

 ** [tags](#API_CreateVpcLink_RequestSyntax) **   <a name="apigw-CreateVpcLink-request-tags"></a>
The key-value map of strings. The valid character set is [a-zA-Z\$1-=.\$1:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.  
Type: String to string map  
Required: No

 ** [targetArns](#API_CreateVpcLink_RequestSyntax) **   <a name="apigw-CreateVpcLink-request-targetArns"></a>
The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.  
Type: Array of strings  
Required: Yes

## Response Syntax
<a name="API_CreateVpcLink_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "description": "string",
   "id": "string",
   "name": "string",
   "status": "string",
   "statusMessage": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetArns": [ "string" ]
}
```

## Response Elements
<a name="API_CreateVpcLink_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [description](#API_CreateVpcLink_ResponseSyntax) **   <a name="apigw-CreateVpcLink-response-description"></a>
The description of the VPC link.  
Type: String

 ** [id](#API_CreateVpcLink_ResponseSyntax) **   <a name="apigw-CreateVpcLink-response-id"></a>
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.  
Type: String

 ** [name](#API_CreateVpcLink_ResponseSyntax) **   <a name="apigw-CreateVpcLink-response-name"></a>
The name used to label and identify the VPC link.  
Type: String

 ** [status](#API_CreateVpcLink_ResponseSyntax) **   <a name="apigw-CreateVpcLink-response-status"></a>
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`.   
Type: String  
Valid Values: `AVAILABLE | PENDING | DELETING | FAILED` 

 ** [statusMessage](#API_CreateVpcLink_ResponseSyntax) **   <a name="apigw-CreateVpcLink-response-statusMessage"></a>
A description about the VPC link status.  
Type: String

 ** [tags](#API_CreateVpcLink_ResponseSyntax) **   <a name="apigw-CreateVpcLink-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [targetArns](#API_CreateVpcLink_ResponseSyntax) **   <a name="apigw-CreateVpcLink-response-targetArns"></a>
The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.  
Type: Array of strings

## Errors
<a name="API_CreateVpcLink_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_CreateVpcLink_Examples"></a>

### Create a VPC link
<a name="API_CreateVpcLink_Example_1"></a>

This example illustrates one usage of CreateVpcLink.

#### Sample Request
<a name="API_CreateVpcLink_Example_1_Request"></a>

```
POST /vpclinks HTTP/1.1
Content-Type: application/json
Host: apigateway.us-eas-t.amazonaws.com
Content-Length: ...
X-Amz-Date: 20160801T235803Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160801/ap-southeast-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sigv4_hash}

{
    "name":"my-test-vpc-link",
    "targetArns": ["arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-vpclink-test-nlb/1f8df693cd094a72"]
}
```

#### Sample Response
<a name="API_CreateVpcLink_Example_1_Response"></a>

```
{    
    "id": "gim7c3",
    "name": "my-test-vpc-link",
    "status": "PENDING",
    "targetArns": "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-vpclink-test-nlb/1f8df693cd094a72"
}
```

## See Also
<a name="API_CreateVpcLink_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/CreateVpcLink) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/CreateVpcLink) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/CreateVpcLink) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/CreateVpcLink) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/CreateVpcLink) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/CreateVpcLink) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/CreateVpcLink) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/CreateVpcLink) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/CreateVpcLink) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/CreateVpcLink) 

# DeleteApiKey
<a name="API_DeleteApiKey"></a>

Deletes the ApiKey resource.

## Request Syntax
<a name="API_DeleteApiKey_RequestSyntax"></a>

```
DELETE /apikeys/api_Key HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteApiKey_RequestParameters"></a>

The request uses the following URI parameters.

 ** [api\$1Key](#API_DeleteApiKey_RequestSyntax) **   <a name="apigw-DeleteApiKey-request-uri-apiKey"></a>
The identifier of the ApiKey resource to be deleted.  
Required: Yes

## Request Body
<a name="API_DeleteApiKey_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteApiKey_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteApiKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteApiKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteApiKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteApiKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteApiKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteApiKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteApiKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteApiKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteApiKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteApiKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteApiKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteApiKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteApiKey) 

# DeleteAuthorizer
<a name="API_DeleteAuthorizer"></a>

Deletes an existing Authorizer resource.

## Request Syntax
<a name="API_DeleteAuthorizer_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/authorizers/authorizer_id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAuthorizer_RequestParameters"></a>

The request uses the following URI parameters.

 ** [authorizer\$1id](#API_DeleteAuthorizer_RequestSyntax) **   <a name="apigw-DeleteAuthorizer-request-uri-authorizerId"></a>
The identifier of the Authorizer resource.  
Required: Yes

 ** [restapi\$1id](#API_DeleteAuthorizer_RequestSyntax) **   <a name="apigw-DeleteAuthorizer-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_DeleteAuthorizer_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAuthorizer_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteAuthorizer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteAuthorizer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteAuthorizer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteAuthorizer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteAuthorizer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteAuthorizer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteAuthorizer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteAuthorizer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteAuthorizer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteAuthorizer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteAuthorizer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteAuthorizer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteAuthorizer) 

# DeleteBasePathMapping
<a name="API_DeleteBasePathMapping"></a>

Deletes the BasePathMapping resource.

## Request Syntax
<a name="API_DeleteBasePathMapping_RequestSyntax"></a>

```
DELETE /domainnames/domain_name/basepathmappings/base_path?domainNameId=domainNameId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteBasePathMapping_RequestParameters"></a>

The request uses the following URI parameters.

 ** [base\$1path](#API_DeleteBasePathMapping_RequestSyntax) **   <a name="apigw-DeleteBasePathMapping-request-uri-basePath"></a>
The base path name of the BasePathMapping resource to delete.  
To specify an empty base path, set this parameter to `'(none)'`.  
Required: Yes

 ** [domain\$1name](#API_DeleteBasePathMapping_RequestSyntax) **   <a name="apigw-DeleteBasePathMapping-request-uri-domainName"></a>
The domain name of the BasePathMapping resource to delete.  
Required: Yes

 ** [domainNameId](#API_DeleteBasePathMapping_RequestSyntax) **   <a name="apigw-DeleteBasePathMapping-request-uri-domainNameId"></a>
 The identifier for the domain name resource. Supported only for private custom domain names. 

## Request Body
<a name="API_DeleteBasePathMapping_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteBasePathMapping_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteBasePathMapping_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteBasePathMapping_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteBasePathMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteBasePathMapping) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteBasePathMapping) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteBasePathMapping) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteBasePathMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteBasePathMapping) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteBasePathMapping) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteBasePathMapping) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteBasePathMapping) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteBasePathMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteBasePathMapping) 

# DeleteClientCertificate
<a name="API_DeleteClientCertificate"></a>

Deletes the ClientCertificate resource.

## Request Syntax
<a name="API_DeleteClientCertificate_RequestSyntax"></a>

```
DELETE /clientcertificates/clientcertificate_id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteClientCertificate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientcertificate\$1id](#API_DeleteClientCertificate_RequestSyntax) **   <a name="apigw-DeleteClientCertificate-request-uri-clientCertificateId"></a>
The identifier of the ClientCertificate resource to be deleted.  
Required: Yes

## Request Body
<a name="API_DeleteClientCertificate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteClientCertificate_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteClientCertificate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteClientCertificate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteClientCertificate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteClientCertificate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteClientCertificate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteClientCertificate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteClientCertificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteClientCertificate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteClientCertificate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteClientCertificate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteClientCertificate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteClientCertificate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteClientCertificate) 

# DeleteDeployment
<a name="API_DeleteDeployment"></a>

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

## Request Syntax
<a name="API_DeleteDeployment_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/deployments/deployment_id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDeployment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [deployment\$1id](#API_DeleteDeployment_RequestSyntax) **   <a name="apigw-DeleteDeployment-request-uri-deploymentId"></a>
The identifier of the Deployment resource to delete.  
Required: Yes

 ** [restapi\$1id](#API_DeleteDeployment_RequestSyntax) **   <a name="apigw-DeleteDeployment-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_DeleteDeployment_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDeployment_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteDeployment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteDeployment) 

# DeleteDocumentationPart
<a name="API_DeleteDocumentationPart"></a>

Deletes a documentation part

## Request Syntax
<a name="API_DeleteDocumentationPart_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/documentation/parts/part_id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDocumentationPart_RequestParameters"></a>

The request uses the following URI parameters.

 ** [part\$1id](#API_DeleteDocumentationPart_RequestSyntax) **   <a name="apigw-DeleteDocumentationPart-request-uri-documentationPartId"></a>
The identifier of the to-be-deleted documentation part.  
Required: Yes

 ** [restapi\$1id](#API_DeleteDocumentationPart_RequestSyntax) **   <a name="apigw-DeleteDocumentationPart-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_DeleteDocumentationPart_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDocumentationPart_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteDocumentationPart_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteDocumentationPart_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteDocumentationPart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteDocumentationPart) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteDocumentationPart) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteDocumentationPart) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteDocumentationPart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteDocumentationPart) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteDocumentationPart) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteDocumentationPart) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteDocumentationPart) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteDocumentationPart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteDocumentationPart) 

# DeleteDocumentationVersion
<a name="API_DeleteDocumentationVersion"></a>

Deletes a documentation version.

## Request Syntax
<a name="API_DeleteDocumentationVersion_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/documentation/versions/doc_version HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDocumentationVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [doc\$1version](#API_DeleteDocumentationVersion_RequestSyntax) **   <a name="apigw-DeleteDocumentationVersion-request-uri-documentationVersion"></a>
The version identifier of a to-be-deleted documentation snapshot.  
Required: Yes

 ** [restapi\$1id](#API_DeleteDocumentationVersion_RequestSyntax) **   <a name="apigw-DeleteDocumentationVersion-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_DeleteDocumentationVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDocumentationVersion_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteDocumentationVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteDocumentationVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteDocumentationVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteDocumentationVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteDocumentationVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteDocumentationVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteDocumentationVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteDocumentationVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteDocumentationVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteDocumentationVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteDocumentationVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteDocumentationVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteDocumentationVersion) 

# DeleteDomainName
<a name="API_DeleteDomainName"></a>

Deletes the DomainName resource.

## Request Syntax
<a name="API_DeleteDomainName_RequestSyntax"></a>

```
DELETE /domainnames/domain_name?domainNameId=domainNameId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDomainName_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domain\$1name](#API_DeleteDomainName_RequestSyntax) **   <a name="apigw-DeleteDomainName-request-uri-domainName"></a>
The name of the DomainName resource to be deleted.  
Required: Yes

 ** [domainNameId](#API_DeleteDomainName_RequestSyntax) **   <a name="apigw-DeleteDomainName-request-uri-domainNameId"></a>
 The identifier for the domain name resource. Supported only for private custom domain names. 

## Request Body
<a name="API_DeleteDomainName_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDomainName_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteDomainName_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteDomainName_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteDomainName_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteDomainName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteDomainName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteDomainName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteDomainName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteDomainName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteDomainName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteDomainName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteDomainName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteDomainName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteDomainName) 

# DeleteDomainNameAccessAssociation
<a name="API_DeleteDomainNameAccessAssociation"></a>

 Deletes the DomainNameAccessAssociation resource.

Only the AWS account that created the DomainNameAccessAssociation resource can delete it. To stop an access association source in another AWS account from accessing your private custom domain name, use the RejectDomainNameAccessAssociation operation.

## Request Syntax
<a name="API_DeleteDomainNameAccessAssociation_RequestSyntax"></a>

```
DELETE /domainnameaccessassociations/domain_name_access_association_arn HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDomainNameAccessAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domain\$1name\$1access\$1association\$1arn](#API_DeleteDomainNameAccessAssociation_RequestSyntax) **   <a name="apigw-DeleteDomainNameAccessAssociation-request-uri-domainNameAccessAssociationArn"></a>
 The ARN of the domain name access association resource.  
Required: Yes

## Request Body
<a name="API_DeleteDomainNameAccessAssociation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDomainNameAccessAssociation_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteDomainNameAccessAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteDomainNameAccessAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteDomainNameAccessAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteDomainNameAccessAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteDomainNameAccessAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteDomainNameAccessAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteDomainNameAccessAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteDomainNameAccessAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteDomainNameAccessAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteDomainNameAccessAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteDomainNameAccessAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteDomainNameAccessAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteDomainNameAccessAssociation) 

# DeleteGatewayResponse
<a name="API_DeleteGatewayResponse"></a>

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

## Request Syntax
<a name="API_DeleteGatewayResponse_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/gatewayresponses/response_type HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteGatewayResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [response\$1type](#API_DeleteGatewayResponse_RequestSyntax) **   <a name="apigw-DeleteGatewayResponse-request-uri-responseType"></a>
The response type of the associated GatewayResponse.  
Valid Values: `DEFAULT_4XX | DEFAULT_5XX | RESOURCE_NOT_FOUND | UNAUTHORIZED | INVALID_API_KEY | ACCESS_DENIED | AUTHORIZER_FAILURE | AUTHORIZER_CONFIGURATION_ERROR | INVALID_SIGNATURE | EXPIRED_TOKEN | MISSING_AUTHENTICATION_TOKEN | INTEGRATION_FAILURE | INTEGRATION_TIMEOUT | API_CONFIGURATION_ERROR | UNSUPPORTED_MEDIA_TYPE | BAD_REQUEST_PARAMETERS | BAD_REQUEST_BODY | REQUEST_TOO_LARGE | THROTTLED | QUOTA_EXCEEDED | WAF_FILTERED`   
Required: Yes

 ** [restapi\$1id](#API_DeleteGatewayResponse_RequestSyntax) **   <a name="apigw-DeleteGatewayResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_DeleteGatewayResponse_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteGatewayResponse_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteGatewayResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteGatewayResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteGatewayResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteGatewayResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteGatewayResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteGatewayResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteGatewayResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteGatewayResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteGatewayResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteGatewayResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteGatewayResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteGatewayResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteGatewayResponse) 

# DeleteIntegration
<a name="API_DeleteIntegration"></a>

Represents a delete integration.

## Request Syntax
<a name="API_DeleteIntegration_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/resources/resource_id/methods/http_method/integration HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_DeleteIntegration_RequestSyntax) **   <a name="apigw-DeleteIntegration-request-uri-httpMethod"></a>
Specifies a delete integration request's HTTP method.  
Required: Yes

 ** [resource\$1id](#API_DeleteIntegration_RequestSyntax) **   <a name="apigw-DeleteIntegration-request-uri-resourceId"></a>
Specifies a delete integration request's resource identifier.  
Required: Yes

 ** [restapi\$1id](#API_DeleteIntegration_RequestSyntax) **   <a name="apigw-DeleteIntegration-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_DeleteIntegration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteIntegration_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteIntegration) 

# DeleteIntegrationResponse
<a name="API_DeleteIntegrationResponse"></a>

Represents a delete integration response.

## Request Syntax
<a name="API_DeleteIntegrationResponse_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/resources/resource_id/methods/http_method/integration/responses/status_code HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteIntegrationResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_DeleteIntegrationResponse_RequestSyntax) **   <a name="apigw-DeleteIntegrationResponse-request-uri-httpMethod"></a>
Specifies a delete integration response request's HTTP method.  
Required: Yes

 ** [resource\$1id](#API_DeleteIntegrationResponse_RequestSyntax) **   <a name="apigw-DeleteIntegrationResponse-request-uri-resourceId"></a>
Specifies a delete integration response request's resource identifier.  
Required: Yes

 ** [restapi\$1id](#API_DeleteIntegrationResponse_RequestSyntax) **   <a name="apigw-DeleteIntegrationResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [status\$1code](#API_DeleteIntegrationResponse_RequestSyntax) **   <a name="apigw-DeleteIntegrationResponse-request-uri-statusCode"></a>
Specifies a delete integration response request's status code.  
Pattern: `[1-5]\d\d`   
Required: Yes

## Request Body
<a name="API_DeleteIntegrationResponse_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteIntegrationResponse_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteIntegrationResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteIntegrationResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteIntegrationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteIntegrationResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteIntegrationResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteIntegrationResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteIntegrationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteIntegrationResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteIntegrationResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteIntegrationResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteIntegrationResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteIntegrationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteIntegrationResponse) 

# DeleteMethod
<a name="API_DeleteMethod"></a>

Deletes an existing Method resource.

## Request Syntax
<a name="API_DeleteMethod_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/resources/resource_id/methods/http_method HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteMethod_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_DeleteMethod_RequestSyntax) **   <a name="apigw-DeleteMethod-request-uri-httpMethod"></a>
The HTTP verb of the Method resource.  
Required: Yes

 ** [resource\$1id](#API_DeleteMethod_RequestSyntax) **   <a name="apigw-DeleteMethod-request-uri-resourceId"></a>
The Resource identifier for the Method resource.  
Required: Yes

 ** [restapi\$1id](#API_DeleteMethod_RequestSyntax) **   <a name="apigw-DeleteMethod-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_DeleteMethod_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteMethod_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteMethod_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteMethod_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteMethod_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteMethod) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteMethod) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteMethod) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteMethod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteMethod) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteMethod) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteMethod) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteMethod) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteMethod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteMethod) 

# DeleteMethodResponse
<a name="API_DeleteMethodResponse"></a>

Deletes an existing MethodResponse resource.

## Request Syntax
<a name="API_DeleteMethodResponse_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/resources/resource_id/methods/http_method/responses/status_code HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteMethodResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_DeleteMethodResponse_RequestSyntax) **   <a name="apigw-DeleteMethodResponse-request-uri-httpMethod"></a>
The HTTP verb of the Method resource.  
Required: Yes

 ** [resource\$1id](#API_DeleteMethodResponse_RequestSyntax) **   <a name="apigw-DeleteMethodResponse-request-uri-resourceId"></a>
The Resource identifier for the MethodResponse resource.  
Required: Yes

 ** [restapi\$1id](#API_DeleteMethodResponse_RequestSyntax) **   <a name="apigw-DeleteMethodResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [status\$1code](#API_DeleteMethodResponse_RequestSyntax) **   <a name="apigw-DeleteMethodResponse-request-uri-statusCode"></a>
The status code identifier for the MethodResponse resource.  
Pattern: `[1-5]\d\d`   
Required: Yes

## Request Body
<a name="API_DeleteMethodResponse_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteMethodResponse_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteMethodResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteMethodResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteMethodResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteMethodResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteMethodResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteMethodResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteMethodResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteMethodResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteMethodResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteMethodResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteMethodResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteMethodResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteMethodResponse) 

# DeleteModel
<a name="API_DeleteModel"></a>

Deletes a model.

## Request Syntax
<a name="API_DeleteModel_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/models/model_name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [model\$1name](#API_DeleteModel_RequestSyntax) **   <a name="apigw-DeleteModel-request-uri-modelName"></a>
The name of the model to delete.  
Required: Yes

 ** [restapi\$1id](#API_DeleteModel_RequestSyntax) **   <a name="apigw-DeleteModel-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_DeleteModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteModel_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteModel) 

# DeleteRequestValidator
<a name="API_DeleteRequestValidator"></a>

Deletes a RequestValidator of a given RestApi.

## Request Syntax
<a name="API_DeleteRequestValidator_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/requestvalidators/requestvalidator_id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteRequestValidator_RequestParameters"></a>

The request uses the following URI parameters.

 ** [requestvalidator\$1id](#API_DeleteRequestValidator_RequestSyntax) **   <a name="apigw-DeleteRequestValidator-request-uri-requestValidatorId"></a>
The identifier of the RequestValidator to be deleted.  
Required: Yes

 ** [restapi\$1id](#API_DeleteRequestValidator_RequestSyntax) **   <a name="apigw-DeleteRequestValidator-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_DeleteRequestValidator_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteRequestValidator_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteRequestValidator_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteRequestValidator_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteRequestValidator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteRequestValidator) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteRequestValidator) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteRequestValidator) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteRequestValidator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteRequestValidator) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteRequestValidator) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteRequestValidator) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteRequestValidator) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteRequestValidator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteRequestValidator) 

# DeleteResource
<a name="API_DeleteResource"></a>

Deletes a Resource resource.

## Request Syntax
<a name="API_DeleteResource_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/resources/resource_id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resource\$1id](#API_DeleteResource_RequestSyntax) **   <a name="apigw-DeleteResource-request-uri-resourceId"></a>
The identifier of the Resource resource.  
Required: Yes

 ** [restapi\$1id](#API_DeleteResource_RequestSyntax) **   <a name="apigw-DeleteResource-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_DeleteResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteResource_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteResource) 

# DeleteRestApi
<a name="API_DeleteRestApi"></a>

Deletes the specified API.

## Request Syntax
<a name="API_DeleteRestApi_RequestSyntax"></a>

```
DELETE /restapis/restapi_id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteRestApi_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_DeleteRestApi_RequestSyntax) **   <a name="apigw-DeleteRestApi-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_DeleteRestApi_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteRestApi_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteRestApi_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteRestApi_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteRestApi_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteRestApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteRestApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteRestApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteRestApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteRestApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteRestApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteRestApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteRestApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteRestApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteRestApi) 

# DeleteStage
<a name="API_DeleteStage"></a>

Deletes a Stage resource.

## Request Syntax
<a name="API_DeleteStage_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/stages/stage_name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteStage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_DeleteStage_RequestSyntax) **   <a name="apigw-DeleteStage-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [stage\$1name](#API_DeleteStage_RequestSyntax) **   <a name="apigw-DeleteStage-request-uri-stageName"></a>
The name of the Stage resource to delete.  
Required: Yes

## Request Body
<a name="API_DeleteStage_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteStage_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteStage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteStage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteStage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteStage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteStage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteStage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteStage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteStage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteStage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteStage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteStage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteStage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteStage) 

# DeleteUsagePlan
<a name="API_DeleteUsagePlan"></a>

Deletes a usage plan of a given plan Id.

## Request Syntax
<a name="API_DeleteUsagePlan_RequestSyntax"></a>

```
DELETE /usageplans/usageplanId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteUsagePlan_RequestParameters"></a>

The request uses the following URI parameters.

 ** [usageplanId](#API_DeleteUsagePlan_RequestSyntax) **   <a name="apigw-DeleteUsagePlan-request-uri-usagePlanId"></a>
The Id of the to-be-deleted usage plan.  
Required: Yes

## Request Body
<a name="API_DeleteUsagePlan_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteUsagePlan_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteUsagePlan_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteUsagePlan_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteUsagePlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteUsagePlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteUsagePlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteUsagePlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteUsagePlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteUsagePlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteUsagePlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteUsagePlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteUsagePlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteUsagePlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteUsagePlan) 

# DeleteUsagePlanKey
<a name="API_DeleteUsagePlanKey"></a>

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

## Request Syntax
<a name="API_DeleteUsagePlanKey_RequestSyntax"></a>

```
DELETE /usageplans/usageplanId/keys/keyId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteUsagePlanKey_RequestParameters"></a>

The request uses the following URI parameters.

 ** [keyId](#API_DeleteUsagePlanKey_RequestSyntax) **   <a name="apigw-DeleteUsagePlanKey-request-uri-keyId"></a>
The Id of the UsagePlanKey resource to be deleted.  
Required: Yes

 ** [usageplanId](#API_DeleteUsagePlanKey_RequestSyntax) **   <a name="apigw-DeleteUsagePlanKey-request-uri-usagePlanId"></a>
The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.  
Required: Yes

## Request Body
<a name="API_DeleteUsagePlanKey_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteUsagePlanKey_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteUsagePlanKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteUsagePlanKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteUsagePlanKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteUsagePlanKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteUsagePlanKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteUsagePlanKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteUsagePlanKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteUsagePlanKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteUsagePlanKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteUsagePlanKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteUsagePlanKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteUsagePlanKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteUsagePlanKey) 

# DeleteVpcLink
<a name="API_DeleteVpcLink"></a>

Deletes an existing VpcLink of a specified identifier.

## Request Syntax
<a name="API_DeleteVpcLink_RequestSyntax"></a>

```
DELETE /vpclinks/vpclink_id HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteVpcLink_RequestParameters"></a>

The request uses the following URI parameters.

 ** [vpclink\$1id](#API_DeleteVpcLink_RequestSyntax) **   <a name="apigw-DeleteVpcLink-request-uri-vpcLinkId"></a>
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.  
Required: Yes

## Request Body
<a name="API_DeleteVpcLink_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteVpcLink_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteVpcLink_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteVpcLink_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_DeleteVpcLink_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/DeleteVpcLink) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/DeleteVpcLink) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/DeleteVpcLink) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/DeleteVpcLink) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/DeleteVpcLink) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/DeleteVpcLink) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/DeleteVpcLink) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/DeleteVpcLink) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/DeleteVpcLink) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/DeleteVpcLink) 

# FlushStageAuthorizersCache
<a name="API_FlushStageAuthorizersCache"></a>

Flushes all authorizer cache entries on a stage.

## Request Syntax
<a name="API_FlushStageAuthorizersCache_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/stages/stage_name/cache/authorizers HTTP/1.1
```

## URI Request Parameters
<a name="API_FlushStageAuthorizersCache_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_FlushStageAuthorizersCache_RequestSyntax) **   <a name="apigw-FlushStageAuthorizersCache-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [stage\$1name](#API_FlushStageAuthorizersCache_RequestSyntax) **   <a name="apigw-FlushStageAuthorizersCache-request-uri-stageName"></a>
The name of the stage to flush.  
Required: Yes

## Request Body
<a name="API_FlushStageAuthorizersCache_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_FlushStageAuthorizersCache_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_FlushStageAuthorizersCache_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_FlushStageAuthorizersCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_FlushStageAuthorizersCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/FlushStageAuthorizersCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/FlushStageAuthorizersCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/FlushStageAuthorizersCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/FlushStageAuthorizersCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/FlushStageAuthorizersCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/FlushStageAuthorizersCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/FlushStageAuthorizersCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/FlushStageAuthorizersCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/FlushStageAuthorizersCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/FlushStageAuthorizersCache) 

# FlushStageCache
<a name="API_FlushStageCache"></a>

Flushes a stage's cache.

## Request Syntax
<a name="API_FlushStageCache_RequestSyntax"></a>

```
DELETE /restapis/restapi_id/stages/stage_name/cache/data HTTP/1.1
```

## URI Request Parameters
<a name="API_FlushStageCache_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_FlushStageCache_RequestSyntax) **   <a name="apigw-FlushStageCache-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [stage\$1name](#API_FlushStageCache_RequestSyntax) **   <a name="apigw-FlushStageCache-request-uri-stageName"></a>
The name of the stage to flush its cache.  
Required: Yes

## Request Body
<a name="API_FlushStageCache_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_FlushStageCache_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_FlushStageCache_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_FlushStageCache_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_FlushStageCache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/FlushStageCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/FlushStageCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/FlushStageCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/FlushStageCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/FlushStageCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/FlushStageCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/FlushStageCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/FlushStageCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/FlushStageCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/FlushStageCache) 

# GenerateClientCertificate
<a name="API_GenerateClientCertificate"></a>

Generates a ClientCertificate resource.

## Request Syntax
<a name="API_GenerateClientCertificate_RequestSyntax"></a>

```
POST /clientcertificates HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_GenerateClientCertificate_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GenerateClientCertificate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_GenerateClientCertificate_RequestSyntax) **   <a name="apigw-GenerateClientCertificate-request-description"></a>
The description of the ClientCertificate.  
Type: String  
Required: No

 ** [tags](#API_GenerateClientCertificate_RequestSyntax) **   <a name="apigw-GenerateClientCertificate-request-tags"></a>
The key-value map of strings. The valid character set is [a-zA-Z\$1-=.\$1:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_GenerateClientCertificate_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "clientCertificateId": "string",
   "createdDate": number,
   "description": "string",
   "expirationDate": number,
   "pemEncodedCertificate": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GenerateClientCertificate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [clientCertificateId](#API_GenerateClientCertificate_ResponseSyntax) **   <a name="apigw-GenerateClientCertificate-response-clientCertificateId"></a>
The identifier of the client certificate.  
Type: String

 ** [createdDate](#API_GenerateClientCertificate_ResponseSyntax) **   <a name="apigw-GenerateClientCertificate-response-createdDate"></a>
The timestamp when the client certificate was created.  
Type: Timestamp

 ** [description](#API_GenerateClientCertificate_ResponseSyntax) **   <a name="apigw-GenerateClientCertificate-response-description"></a>
The description of the client certificate.  
Type: String

 ** [expirationDate](#API_GenerateClientCertificate_ResponseSyntax) **   <a name="apigw-GenerateClientCertificate-response-expirationDate"></a>
The timestamp when the client certificate will expire.  
Type: Timestamp

 ** [pemEncodedCertificate](#API_GenerateClientCertificate_ResponseSyntax) **   <a name="apigw-GenerateClientCertificate-response-pemEncodedCertificate"></a>
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .  
Type: String

 ** [tags](#API_GenerateClientCertificate_ResponseSyntax) **   <a name="apigw-GenerateClientCertificate-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

## Errors
<a name="API_GenerateClientCertificate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GenerateClientCertificate_Examples"></a>

### Generate a client-side certificate
<a name="API_GenerateClientCertificate_Example_1"></a>

This example illustrates one usage of GenerateClientCertificate.

#### Sample Request
<a name="API_GenerateClientCertificate_Example_1_Request"></a>

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

{
    "description": "my-second-client-cert"
}
```

#### Sample Response
<a name="API_GenerateClientCertificate_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-clientcertificate-{rel}.html",
      "name": "clientcertificate",
      "templated": true
    },
    "self": {
      "href": "/clientcertificates/9ao60f"
    },
    "clientcertificate:delete": {
      "href": "/clientcertificates/9ao60f"
    },
    "clientcertificate:update": {
      "href": "/clientcertificates/9ao60f"
    }
  },
  "clientCertificateId": "9ao60f",
  "createdDate": "2016-06-15T22:33:13Z",
  "description": "my-second-client-cert",
  "expirationDate": "2017-06-15T22:33:13Z",
  "pemEncodedCertificate": "-----BEGIN CERTIFICATE-----\r\nMIIC6T...2yQAGEHvs=\r\n-----END CERTIFICATE-----"
}
```

## See Also
<a name="API_GenerateClientCertificate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GenerateClientCertificate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GenerateClientCertificate) 

# GetAccount
<a name="API_GetAccount"></a>

Gets information about the current Account resource.

## Request Syntax
<a name="API_GetAccount_RequestSyntax"></a>

```
GET /account HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAccount_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetAccount_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAccount_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "apiKeyVersion": "string",
   "cloudwatchRoleArn": "string",
   "features": [ "string" ],
   "throttleSettings": { 
      "burstLimit": number,
      "rateLimit": number
   }
}
```

## Response Elements
<a name="API_GetAccount_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [apiKeyVersion](#API_GetAccount_ResponseSyntax) **   <a name="apigw-GetAccount-response-apiKeyVersion"></a>
The version of the API keys used for the account.  
Type: String

 ** [cloudwatchRoleArn](#API_GetAccount_ResponseSyntax) **   <a name="apigw-GetAccount-response-cloudwatchRoleArn"></a>
The ARN of an Amazon CloudWatch role for the current Account.   
Type: String

 ** [features](#API_GetAccount_ResponseSyntax) **   <a name="apigw-GetAccount-response-features"></a>
A list of features supported for the account. When usage plans are enabled, the features list will include an entry of `"UsagePlans"`.  
Type: Array of strings

 ** [throttleSettings](#API_GetAccount_ResponseSyntax) **   <a name="apigw-GetAccount-response-throttleSettings"></a>
Specifies the API request limits configured for the current Account.  
Type: [ThrottleSettings](API_ThrottleSettings.md) object

## Errors
<a name="API_GetAccount_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetAccount_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetAccount) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetAccount) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetAccount) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetAccount) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetAccount) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetAccount) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetAccount) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetAccount) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetAccount) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetAccount) 

# GetApiKey
<a name="API_GetApiKey"></a>

Gets information about the current ApiKey resource.

## Request Syntax
<a name="API_GetApiKey_RequestSyntax"></a>

```
GET /apikeys/api_Key?includeValue=includeValue HTTP/1.1
```

## URI Request Parameters
<a name="API_GetApiKey_RequestParameters"></a>

The request uses the following URI parameters.

 ** [api\$1Key](#API_GetApiKey_RequestSyntax) **   <a name="apigw-GetApiKey-request-uri-apiKey"></a>
The identifier of the ApiKey resource.  
Required: Yes

 ** [includeValue](#API_GetApiKey_RequestSyntax) **   <a name="apigw-GetApiKey-request-uri-includeValue"></a>
A boolean flag to specify whether (`true`) or not (`false`) the result contains the key value.

## Request Body
<a name="API_GetApiKey_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetApiKey_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdDate": number,
   "customerId": "string",
   "description": "string",
   "enabled": boolean,
   "id": "string",
   "lastUpdatedDate": number,
   "name": "string",
   "stageKeys": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "value": "string"
}
```

## Response Elements
<a name="API_GetApiKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdDate](#API_GetApiKey_ResponseSyntax) **   <a name="apigw-GetApiKey-response-createdDate"></a>
The timestamp when the API Key was created.  
Type: Timestamp

 ** [customerId](#API_GetApiKey_ResponseSyntax) **   <a name="apigw-GetApiKey-response-customerId"></a>
An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.  
Type: String

 ** [description](#API_GetApiKey_ResponseSyntax) **   <a name="apigw-GetApiKey-response-description"></a>
The description of the API Key.  
Type: String

 ** [enabled](#API_GetApiKey_ResponseSyntax) **   <a name="apigw-GetApiKey-response-enabled"></a>
Specifies whether the API Key can be used by callers.  
Type: Boolean

 ** [id](#API_GetApiKey_ResponseSyntax) **   <a name="apigw-GetApiKey-response-id"></a>
The identifier of the API Key.  
Type: String

 ** [lastUpdatedDate](#API_GetApiKey_ResponseSyntax) **   <a name="apigw-GetApiKey-response-lastUpdatedDate"></a>
The timestamp when the API Key was last updated.  
Type: Timestamp

 ** [name](#API_GetApiKey_ResponseSyntax) **   <a name="apigw-GetApiKey-response-name"></a>
The name of the API Key.  
Type: String

 ** [stageKeys](#API_GetApiKey_ResponseSyntax) **   <a name="apigw-GetApiKey-response-stageKeys"></a>
A list of Stage resources that are associated with the ApiKey resource.  
Type: Array of strings

 ** [tags](#API_GetApiKey_ResponseSyntax) **   <a name="apigw-GetApiKey-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [value](#API_GetApiKey_ResponseSyntax) **   <a name="apigw-GetApiKey-response-value"></a>
The value of the API Key.  
Type: String

## Errors
<a name="API_GetApiKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetApiKey_Examples"></a>

### Retrieve an API Key
<a name="API_GetApiKey_Example_1"></a>

 The following example request retrieves an API key. 

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

#### Sample Request
<a name="API_GetApiKey_Example_1_Request"></a>

```
GET /apikeys/hzYAVO9Sg98nsNh65VfX81M84O2kyXVy6K1xwHD76 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T221142Z
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}
```

#### Sample Response
<a name="API_GetApiKey_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-apikey-{rel}.html",
      "name": "apikey",
      "templated": true
    },
    "self": {
      "href": "/apikeys/hzYAVO9Sg98nsNh65VfX81M84O2kyXVy6K1xwHD76"
    },
    "apikey:delete": {
      "href": "/apikeys/hzYAVO9Sg98nsNh65VfX81M84O2kyXVy6K1xwHD76"
    },
    "apikey:update": {
      "href": "/apikeys/hzYAVO9Sg98nsNh65VfX81M84O2kyXVy6K1xwHD76"
    }
  },
  "createdDate": "2015-11-06T23:51:03Z",
  "enabled": true,
  "id": "hzYAVO9Sg98nsNh65VfX81M84O2kyXVy6K1xwHD76",
  "lastUpdatedDate": "2016-06-06T23:44:43Z",
  "name": "my_test_gateway_service",
  "stageKeys": [
    "h4ah70cvmb/beta",
    "fugvjdxtri/stage2"
  ]
}
```

## See Also
<a name="API_GetApiKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetApiKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetApiKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetApiKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetApiKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetApiKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetApiKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetApiKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetApiKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetApiKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetApiKey) 

# GetApiKeys
<a name="API_GetApiKeys"></a>

Gets information about the current ApiKeys resource.

## Request Syntax
<a name="API_GetApiKeys_RequestSyntax"></a>

```
GET /apikeys?customerId=customerId&includeValues=includeValues&limit=limit&name=nameQuery&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetApiKeys_RequestParameters"></a>

The request uses the following URI parameters.

 ** [customerId](#API_GetApiKeys_RequestSyntax) **   <a name="apigw-GetApiKeys-request-uri-customerId"></a>
The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

 ** [includeValues](#API_GetApiKeys_RequestSyntax) **   <a name="apigw-GetApiKeys-request-uri-includeValues"></a>
A boolean flag to specify whether (`true`) or not (`false`) the result contains key values.

 ** [limit](#API_GetApiKeys_RequestSyntax) **   <a name="apigw-GetApiKeys-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [nameQuery](#API_GetApiKeys_RequestSyntax) **   <a name="apigw-GetApiKeys-request-uri-nameQuery"></a>
The name of queried API keys.

 ** [position](#API_GetApiKeys_RequestSyntax) **   <a name="apigw-GetApiKeys-request-uri-position"></a>
The current pagination position in the paged result set.

## Request Body
<a name="API_GetApiKeys_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetApiKeys_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "createdDate": number,
         "customerId": "string",
         "description": "string",
         "enabled": boolean,
         "id": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "stageKeys": [ "string" ],
         "tags": { 
            "string" : "string" 
         },
         "value": "string"
      }
   ],
   "position": "string",
   "warnings": [ "string" ]
}
```

## Response Elements
<a name="API_GetApiKeys_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetApiKeys_ResponseSyntax) **   <a name="apigw-GetApiKeys-response-item"></a>
The current page of elements from this collection.  
Type: Array of [ApiKey](API_ApiKey.md) objects

 ** [position](#API_GetApiKeys_ResponseSyntax) **   <a name="apigw-GetApiKeys-response-position"></a>
The current pagination position in the paged result set.  
Type: String

 ** [warnings](#API_GetApiKeys_ResponseSyntax) **   <a name="apigw-GetApiKeys-response-warnings"></a>
A list of warning messages logged during the import of API keys when the `failOnWarnings` option is set to true.  
Type: Array of strings

## Errors
<a name="API_GetApiKeys_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetApiKeys_Examples"></a>

### Retrieve an API key
<a name="API_GetApiKeys_Example_1"></a>

The following example request retrieves the available API keys in the caller's AWS account.

A successful response returns the requested `ApiKey` resources that can be navigated to by following the linked item or examining the embedded item resource.

#### Sample Request
<a name="API_GetApiKeys_Example_1_Request"></a>

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

#### Sample Response
<a name="API_GetApiKeys_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-apikey-{rel}.html",
        "name": "apikey",
        "templated": true
      }
    ],
    "self": {
      "href": "/apikeys"
    },
    "apikey:by-key": {
      "href": "/apikeys/{api_Key}",
      "templated": true
    },
    "apikey:create": {
      "href": "/apikeys"
    },
    "apikey:delete": {
      "href": "/apikeys/{api_Key}",
      "templated": true
    },
    "item": {
      "href": "/apikeys/hzYAVO9Sg98nsNh45VfX81M84O2kyXVy6K1xwHD76"
    }
  },
  "_embedded": {
    "item": {
      "_links": {
        "self": {
          "href": "/apikeys/hzYAVO9Sg98nsNh45VfX81M84O2kyXVy6K1xwHD76"
        },
        "apikey:delete": {
          "href": "/apikeys/hzYAVO9Sg98nsNh45VfX81M84O2kyXVy6K1xwHD76"
        },
        "apikey:update": {
          "href": "/apikeys/hzYAVO9Sg98nsNh45VfX81M84O2kyXVy6K1xwHD76"
        }
      },
      "createdDate": "2015-11-06T23:51:03Z",
      "enabled": true,
      "id": "hzYAVO9Sg98nsNh45VfX81M84O2kyXVy6K1xwHD76",
      "lastUpdatedDate": "2016-01-26T20:05:38Z",
      "name": "my_test_gateway_service",
      "stageKeys": "h4ah70cvmb/beta"
    }
  }
}
```

## See Also
<a name="API_GetApiKeys_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetApiKeys) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetApiKeys) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetApiKeys) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetApiKeys) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetApiKeys) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetApiKeys) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetApiKeys) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetApiKeys) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetApiKeys) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetApiKeys) 

# GetAuthorizer
<a name="API_GetAuthorizer"></a>

Describe an existing Authorizer resource.

## Request Syntax
<a name="API_GetAuthorizer_RequestSyntax"></a>

```
GET /restapis/restapi_id/authorizers/authorizer_id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAuthorizer_RequestParameters"></a>

The request uses the following URI parameters.

 ** [authorizer\$1id](#API_GetAuthorizer_RequestSyntax) **   <a name="apigw-GetAuthorizer-request-uri-authorizerId"></a>
The identifier of the Authorizer resource.  
Required: Yes

 ** [restapi\$1id](#API_GetAuthorizer_RequestSyntax) **   <a name="apigw-GetAuthorizer-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetAuthorizer_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAuthorizer_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "authorizerCredentials": "string",
   "authorizerResultTtlInSeconds": number,
   "authorizerUri": "string",
   "authType": "string",
   "id": "string",
   "identitySource": "string",
   "identityValidationExpression": "string",
   "name": "string",
   "providerARNs": [ "string" ],
   "type": "string"
}
```

## Response Elements
<a name="API_GetAuthorizer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [authorizerCredentials](#API_GetAuthorizer_ResponseSyntax) **   <a name="apigw-GetAuthorizer-response-authorizerCredentials"></a>
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.  
Type: String

 ** [authorizerResultTtlInSeconds](#API_GetAuthorizer_ResponseSyntax) **   <a name="apigw-GetAuthorizer-response-authorizerResultTtlInSeconds"></a>
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.  
Type: Integer

 ** [authorizerUri](#API_GetAuthorizer_ResponseSyntax) **   <a name="apigw-GetAuthorizer-response-authorizerUri"></a>
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`.  
Type: String

 ** [authType](#API_GetAuthorizer_ResponseSyntax) **   <a name="apigw-GetAuthorizer-response-authType"></a>
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.  
Type: String

 ** [id](#API_GetAuthorizer_ResponseSyntax) **   <a name="apigw-GetAuthorizer-response-id"></a>
The identifier for the authorizer resource.  
Type: String

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

 ** [identityValidationExpression](#API_GetAuthorizer_ResponseSyntax) **   <a name="apigw-GetAuthorizer-response-identityValidationExpression"></a>
A validation expression for the incoming identity token. For `TOKEN` authorizers, this value is a regular expression. For `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the `REQUEST` authorizer.  
Type: String

 ** [name](#API_GetAuthorizer_ResponseSyntax) **   <a name="apigw-GetAuthorizer-response-name"></a>
The name of the authorizer.  
Type: String

 ** [providerARNs](#API_GetAuthorizer_ResponseSyntax) **   <a name="apigw-GetAuthorizer-response-providerARNs"></a>
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.   
Type: Array of strings

 ** [type](#API_GetAuthorizer_ResponseSyntax) **   <a name="apigw-GetAuthorizer-response-type"></a>
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.  
Type: String  
Valid Values: `TOKEN | REQUEST | COGNITO_USER_POOLS` 

## Errors
<a name="API_GetAuthorizer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetAuthorizer_Examples"></a>

### Retrieve a custom authorizer of a given authorizer identifier
<a name="API_GetAuthorizer_Example_1"></a>

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

#### Sample Request
<a name="API_GetAuthorizer_Example_1_Request"></a>

```
GET /restapis/mxsmn867vb/authorizers/40j2n8 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T231032Z
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}
```

#### Sample Response
<a name="API_GetAuthorizer_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-authorizer-{rel}.html",
      "name": "authorizer",
      "templated": true
    },
    "self": {
      "href": "/restapis/mxsmn867vb/authorizers/40j2n8"
    },
    "authorizer:delete": {
      "href": "/restapis/mxsmn867vb/authorizers/40j2n8"
    },
    "authorizer:update": {
      "href": "/restapis/mxsmn867vb/authorizers/40j2n8"
    }
  },
  "authType": "custom",
  "authorizerResultTtlInSeconds": 300,
  "authorizerUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789012:function:myApiAuthroizer/invocations",
  "id": "40j2n8",
  "identitySource": "method.request.header.Auth",
  "name": "my-cust-auth",
  "type": "TOKEN"
}
```

## See Also
<a name="API_GetAuthorizer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetAuthorizer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetAuthorizer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetAuthorizer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetAuthorizer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetAuthorizer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetAuthorizer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetAuthorizer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetAuthorizer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetAuthorizer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetAuthorizer) 

# GetAuthorizers
<a name="API_GetAuthorizers"></a>

Describe an existing Authorizers resource.

## Request Syntax
<a name="API_GetAuthorizers_RequestSyntax"></a>

```
GET /restapis/restapi_id/authorizers?limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAuthorizers_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetAuthorizers_RequestSyntax) **   <a name="apigw-GetAuthorizers-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetAuthorizers_RequestSyntax) **   <a name="apigw-GetAuthorizers-request-uri-position"></a>
The current pagination position in the paged result set.

 ** [restapi\$1id](#API_GetAuthorizers_RequestSyntax) **   <a name="apigw-GetAuthorizers-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetAuthorizers_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAuthorizers_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "authorizerCredentials": "string",
         "authorizerResultTtlInSeconds": number,
         "authorizerUri": "string",
         "authType": "string",
         "id": "string",
         "identitySource": "string",
         "identityValidationExpression": "string",
         "name": "string",
         "providerARNs": [ "string" ],
         "type": "string"
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetAuthorizers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetAuthorizers_ResponseSyntax) **   <a name="apigw-GetAuthorizers-response-item"></a>
The current page of elements from this collection.  
Type: Array of [Authorizer](API_Authorizer.md) objects

 ** [position](#API_GetAuthorizers_ResponseSyntax) **   <a name="apigw-GetAuthorizers-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetAuthorizers_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetAuthorizers_Examples"></a>

### Get the collection of custom authorizers defined for an API
<a name="API_GetAuthorizers_Example_1"></a>

This example illustrates one usage of GetAuthorizers.

#### Sample Request
<a name="API_GetAuthorizers_Example_1_Request"></a>

```
GET /restapis/86l3267lf6/authorizers HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
Content-Length: 60
X-Amz-Date: 20170223T175134Z
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}
```

#### Sample Response
<a name="API_GetAuthorizers_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-authorizer-{rel}.html",
      "name": "authorizer",
      "templated": true
    },
    "self": {
      "href": "/restapis/86l3267lf6/authorizers"
    },
    "authorizer:by-id": {
      "href": "/restapis/86l3267lf6/authorizers/{authorizer_id}",
      "templated": true
    },
    "authorizer:create": {
      "href": "/restapis/86l3267lf6/authorizers"
    },
    "item": {
      "href": "/restapis/86l3267lf6/authorizers/bs9803"
    }
  },
  "_embedded": {
    "item": {
      "_links": {
        "self": {
          "href": "/restapis/86l3267lf6/authorizers/bs9803"
        },
        "authorizer:delete": {
          "href": "/restapis/86l3267lf6/authorizers/bs9803"
        },
        "authorizer:update": {
          "href": "/restapis/86l3267lf6/authorizers/bs9803"
        }
      },
      "authType": "custom",
      "authorizerResultTtlInSeconds": 300,
      "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:myCustomAuthorizer/invocations",
      "id": "bs9803",
      "identitySource": "method.request.header.Authorization",
      "name": "myCustomAuth",
      "type": "TOKEN"
    }
  }
}
```

## See Also
<a name="API_GetAuthorizers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetAuthorizers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetAuthorizers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetAuthorizers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetAuthorizers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetAuthorizers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetAuthorizers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetAuthorizers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetAuthorizers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetAuthorizers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetAuthorizers) 

# GetBasePathMapping
<a name="API_GetBasePathMapping"></a>

Describe a BasePathMapping resource.

## Request Syntax
<a name="API_GetBasePathMapping_RequestSyntax"></a>

```
GET /domainnames/domain_name/basepathmappings/base_path?domainNameId=domainNameId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBasePathMapping_RequestParameters"></a>

The request uses the following URI parameters.

 ** [base\$1path](#API_GetBasePathMapping_RequestSyntax) **   <a name="apigw-GetBasePathMapping-request-uri-basePath"></a>
The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.  
Required: Yes

 ** [domain\$1name](#API_GetBasePathMapping_RequestSyntax) **   <a name="apigw-GetBasePathMapping-request-uri-domainName"></a>
The domain name of the BasePathMapping resource to be described.  
Required: Yes

 ** [domainNameId](#API_GetBasePathMapping_RequestSyntax) **   <a name="apigw-GetBasePathMapping-request-uri-domainNameId"></a>
The identifier for the domain name resource. Supported only for private custom domain names. 

## Request Body
<a name="API_GetBasePathMapping_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBasePathMapping_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "basePath": "string",
   "restApiId": "string",
   "stage": "string"
}
```

## Response Elements
<a name="API_GetBasePathMapping_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [basePath](#API_GetBasePathMapping_ResponseSyntax) **   <a name="apigw-GetBasePathMapping-response-basePath"></a>
The base path name that callers of the API must provide as part of the URL after the domain name.  
Type: String

 ** [restApiId](#API_GetBasePathMapping_ResponseSyntax) **   <a name="apigw-GetBasePathMapping-response-restApiId"></a>
The string identifier of the associated RestApi.  
Type: String

 ** [stage](#API_GetBasePathMapping_ResponseSyntax) **   <a name="apigw-GetBasePathMapping-response-stage"></a>
The name of the associated stage.  
Type: String

## Errors
<a name="API_GetBasePathMapping_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetBasePathMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetBasePathMapping) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetBasePathMapping) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetBasePathMapping) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetBasePathMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetBasePathMapping) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetBasePathMapping) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetBasePathMapping) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetBasePathMapping) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetBasePathMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetBasePathMapping) 

# GetBasePathMappings
<a name="API_GetBasePathMappings"></a>

Represents a collection of BasePathMapping resources.

## Request Syntax
<a name="API_GetBasePathMappings_RequestSyntax"></a>

```
GET /domainnames/domain_name/basepathmappings?domainNameId=domainNameId&limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetBasePathMappings_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domain\$1name](#API_GetBasePathMappings_RequestSyntax) **   <a name="apigw-GetBasePathMappings-request-uri-domainName"></a>
The domain name of a BasePathMapping resource.  
Required: Yes

 ** [domainNameId](#API_GetBasePathMappings_RequestSyntax) **   <a name="apigw-GetBasePathMappings-request-uri-domainNameId"></a>
 The identifier for the domain name resource. Supported only for private custom domain names. 

 ** [limit](#API_GetBasePathMappings_RequestSyntax) **   <a name="apigw-GetBasePathMappings-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetBasePathMappings_RequestSyntax) **   <a name="apigw-GetBasePathMappings-request-uri-position"></a>
The current pagination position in the paged result set.

## Request Body
<a name="API_GetBasePathMappings_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetBasePathMappings_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "basePath": "string",
         "restApiId": "string",
         "stage": "string"
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetBasePathMappings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetBasePathMappings_ResponseSyntax) **   <a name="apigw-GetBasePathMappings-response-item"></a>
The current page of elements from this collection.  
Type: Array of [BasePathMapping](API_BasePathMapping.md) objects

 ** [position](#API_GetBasePathMappings_ResponseSyntax) **   <a name="apigw-GetBasePathMappings-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetBasePathMappings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetBasePathMappings_Examples"></a>

### Get the base path mappings of a custom domain name
<a name="API_GetBasePathMappings_Example_1"></a>

This example illustrates one usage of GetBasePathMappings.

#### Sample Request
<a name="API_GetBasePathMappings_Example_1_Request"></a>

```
GET /domainnames/a.b.c.com/basepathmappings HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160615T221921Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160615/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
```

#### Sample Response
<a name="API_GetBasePathMappings_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-basepathmapping-{rel}.html",
      "name": "basepathmapping",
      "templated": true
    },
    "self": {
      "href": "/domainnames/a.b.c.com/basepathmappings{?limit}",
      "templated": true
    },
    "basepathmapping:by-path": {
      "href": "/domainnames/a.b.c.com/basepathmappings/{base_path}",
      "templated": true
    },
    "basepathmapping:create": {
      "href": "/domainnames/a.b.c.com/basepathmappings"
    },
    "item": [
      {
        "href": "/domainnames/a.b.c.com/basepathmappings/my-service-api"
      },
      {
        "href": "/domainnames/a.b.c.com/basepathmappings/my-sample-api"
      }
    ]
  },
  "_embedded": {
    "item": [
      {
        "_links": {
          "self": {
            "href": "/domainnames/a.b.c.com/basepathmappings/my-service-api"
          },
          "basepathmapping:create": {
            "href": "/domainnames/a.b.c.com/basepathmappings"
          },
          "basepathmapping:delete": {
            "href": "/domainnames/a.b.c.com/basepathmappings/my-service-api"
          },
          "basepathmapping:update": {
            "href": "/domainnames/a.b.c.com/basepathmappings/my-service-api"
          }
        },
        "basepath": "my-service-api",
        "restApiId": "fugvjdxtri",
        "stage": "stage2"
      },
      {
        "_links": {
          "self": {
            "href": "/domainnames/a.b.c.com/basepathmappings/my-sample-api"
          },
          "basepathmapping:create": {
            "href": "/domainnames/a.b.c.com/basepathmappings"
          },
          "basepathmapping:delete": {
            "href": "/domainnames/a.b.c.com/basepathmappings/my-sample-api"
          },
          "basepathmapping:update": {
            "href": "/domainnames/a.b.c.com/basepathmappings/my-sample-api"
          }
        },
        "basepath": "my-sample-api",
        "restApiId": "fugvjdxtri",
        "stage": "stage1"
      }
    ]
  }
}
```

## See Also
<a name="API_GetBasePathMappings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetBasePathMappings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetBasePathMappings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetBasePathMappings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetBasePathMappings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetBasePathMappings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetBasePathMappings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetBasePathMappings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetBasePathMappings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetBasePathMappings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetBasePathMappings) 

# GetClientCertificate
<a name="API_GetClientCertificate"></a>

Gets information about the current ClientCertificate resource.

## Request Syntax
<a name="API_GetClientCertificate_RequestSyntax"></a>

```
GET /clientcertificates/clientcertificate_id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetClientCertificate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientcertificate\$1id](#API_GetClientCertificate_RequestSyntax) **   <a name="apigw-GetClientCertificate-request-uri-clientCertificateId"></a>
The identifier of the ClientCertificate resource to be described.  
Required: Yes

## Request Body
<a name="API_GetClientCertificate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetClientCertificate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "clientCertificateId": "string",
   "createdDate": number,
   "description": "string",
   "expirationDate": number,
   "pemEncodedCertificate": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetClientCertificate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [clientCertificateId](#API_GetClientCertificate_ResponseSyntax) **   <a name="apigw-GetClientCertificate-response-clientCertificateId"></a>
The identifier of the client certificate.  
Type: String

 ** [createdDate](#API_GetClientCertificate_ResponseSyntax) **   <a name="apigw-GetClientCertificate-response-createdDate"></a>
The timestamp when the client certificate was created.  
Type: Timestamp

 ** [description](#API_GetClientCertificate_ResponseSyntax) **   <a name="apigw-GetClientCertificate-response-description"></a>
The description of the client certificate.  
Type: String

 ** [expirationDate](#API_GetClientCertificate_ResponseSyntax) **   <a name="apigw-GetClientCertificate-response-expirationDate"></a>
The timestamp when the client certificate will expire.  
Type: Timestamp

 ** [pemEncodedCertificate](#API_GetClientCertificate_ResponseSyntax) **   <a name="apigw-GetClientCertificate-response-pemEncodedCertificate"></a>
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .  
Type: String

 ** [tags](#API_GetClientCertificate_ResponseSyntax) **   <a name="apigw-GetClientCertificate-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

## Errors
<a name="API_GetClientCertificate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetClientCertificate_Examples"></a>

### Get the client certificate of a given identifier
<a name="API_GetClientCertificate_Example_1"></a>

This example illustrates one usage of GetClientCertificate.

#### Sample Request
<a name="API_GetClientCertificate_Example_1_Request"></a>

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

#### Sample Response
<a name="API_GetClientCertificate_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-clientcertificate-{rel}.html",
      "name": "clientcertificate",
      "templated": true
    },
    "self": {
      "href": "/clientcertificates/9ao60f"
    },
    "clientcertificate:delete": {
      "href": "/clientcertificates/9ao60f"
    },
    "clientcertificate:update": {
      "href": "/clientcertificates/9ao60f"
    }
  },
  "clientCertificateId": "9ao60f",
  "createdDate": "2016-06-15T22:33:13Z",
  "description": "my second client-side cert",
  "expirationDate": "2017-06-15T22:33:13Z",
  "pemEncodedCertificate": "-----BEGIN CERTIFICATE-----\r\nMIIC6TC...yQAGEHvs=\r\n-----END CERTIFICATE-----"
}
```

## See Also
<a name="API_GetClientCertificate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetClientCertificate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetClientCertificate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetClientCertificate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetClientCertificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetClientCertificate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetClientCertificate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetClientCertificate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetClientCertificate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetClientCertificate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetClientCertificate) 

# GetClientCertificates
<a name="API_GetClientCertificates"></a>

Gets a collection of ClientCertificate resources.

## Request Syntax
<a name="API_GetClientCertificates_RequestSyntax"></a>

```
GET /clientcertificates?limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetClientCertificates_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetClientCertificates_RequestSyntax) **   <a name="apigw-GetClientCertificates-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetClientCertificates_RequestSyntax) **   <a name="apigw-GetClientCertificates-request-uri-position"></a>
The current pagination position in the paged result set.

## Request Body
<a name="API_GetClientCertificates_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetClientCertificates_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "clientCertificateId": "string",
         "createdDate": number,
         "description": "string",
         "expirationDate": number,
         "pemEncodedCertificate": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetClientCertificates_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetClientCertificates_ResponseSyntax) **   <a name="apigw-GetClientCertificates-response-item"></a>
The current page of elements from this collection.  
Type: Array of [ClientCertificate](API_ClientCertificate.md) objects

 ** [position](#API_GetClientCertificates_ResponseSyntax) **   <a name="apigw-GetClientCertificates-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetClientCertificates_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetClientCertificates_Examples"></a>

### Retrieve client certificates
<a name="API_GetClientCertificates_Example_1"></a>

The following example request retrieves the available client certificates in the caller's AWS account.

A successful response returns the requested `ClientCertificate` resources that can be navigated to by following the linked item or examining the embedded item resource.

#### Sample Request
<a name="API_GetClientCertificates_Example_1_Request"></a>

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

#### Sample Response
<a name="API_GetClientCertificates_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-clientcertificate-{rel}.html",
      "name": "clientcertificate",
      "templated": true
    },
    "self": {
      "href": "/clientcertificates"
    },
    "clientcertificate:by-id": {
      "href": "/clientcertificates/{clientcertificate_id}",
      "templated": true
    },
    "clientcertificate:generate": {
      "href": "/clientcertificates"
    },
    "item": {
      "href": "/clientcertificates/xmbiqp"
    }
  },
  "_embedded": {
    "item": {
      "_links": {
        "self": {
          "href": "/clientcertificates/xmbiqp"
        },
        "clientcertificate:delete": {
          "href": "/clientcertificates/xmbiqp"
        },
        "clientcertificate:update": {
          "href": "/clientcertificates/xmbiqp"
        }
      },
      "clientCertificateId": "xmbiqp",get
      "createdDate": "2015-12-08T18:02:16Z",
      "description": "test-client-cert-2",
      "expirationDate": "2016-12-07T18:02:16Z",
      "pemEncodedCertificate": "-----BEGIN CERTIFICATE-----\r\nMIIC6DC...XuHVdZ5r27XRRXEjg==\r\n-----END CERTIFICATE-----"
    }
  }
}
```

## See Also
<a name="API_GetClientCertificates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetClientCertificates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetClientCertificates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetClientCertificates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetClientCertificates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetClientCertificates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetClientCertificates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetClientCertificates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetClientCertificates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetClientCertificates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetClientCertificates) 

# GetDeployment
<a name="API_GetDeployment"></a>

Gets information about a Deployment resource.

## Request Syntax
<a name="API_GetDeployment_RequestSyntax"></a>

```
GET /restapis/restapi_id/deployments/deployment_id?embed=embed HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDeployment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [deployment\$1id](#API_GetDeployment_RequestSyntax) **   <a name="apigw-GetDeployment-request-uri-deploymentId"></a>
The identifier of the Deployment resource to get information about.  
Required: Yes

 ** [embed](#API_GetDeployment_RequestSyntax) **   <a name="apigw-GetDeployment-request-uri-embed"></a>
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`.

 ** [restapi\$1id](#API_GetDeployment_RequestSyntax) **   <a name="apigw-GetDeployment-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetDeployment_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDeployment_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "apiSummary": { 
      "string" : { 
         "string" : { 
            "apiKeyRequired": boolean,
            "authorizationType": "string"
         }
      }
   },
   "createdDate": number,
   "description": "string",
   "id": "string"
}
```

## Response Elements
<a name="API_GetDeployment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [apiSummary](#API_GetDeployment_ResponseSyntax) **   <a name="apigw-GetDeployment-response-apiSummary"></a>
A summary of the RestApi at the date and time that the deployment resource was created.  
Type: String to string to [MethodSnapshot](API_MethodSnapshot.md) object map map

 ** [createdDate](#API_GetDeployment_ResponseSyntax) **   <a name="apigw-GetDeployment-response-createdDate"></a>
The date and time that the deployment resource was created.  
Type: Timestamp

 ** [description](#API_GetDeployment_ResponseSyntax) **   <a name="apigw-GetDeployment-response-description"></a>
The description for the deployment resource.  
Type: String

 ** [id](#API_GetDeployment_ResponseSyntax) **   <a name="apigw-GetDeployment-response-id"></a>
The identifier for the deployment resource.  
Type: String

## Errors
<a name="API_GetDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** ServiceUnavailableException **   
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.  
HTTP Status Code: 503

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetDeployment_Examples"></a>

### Retrieve a deployment
<a name="API_GetDeployment_Example_1"></a>

This example illustrates one usage of GetDeployment.

#### Sample Request
<a name="API_GetDeployment_Example_1_Request"></a>

```
GET /restapis/{restapi_id}/deployments/{deployment-id}?embed=apisummary HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160520T055303Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160520/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={hash}
Cache-Control: no-cache
```

#### Sample Response
<a name="API_GetDeployment_Example_1_Response"></a>

```
{
"_links": {
  "curies": {
    "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-deployment-{rel}.html",
    "name": "deployment",
    "templated": true
  },
  "self": {
    "href": "/restapis/{restapi-id}/deployments/{deployment-id}"
  },
  "deployment:delete": {
    "href": "/restapis/{restapi-id}/deployments/{deployment-id}"
  },
  "deployment:stages": {
    "href": "/restapis/{restapi-id}/stages?deployment_id={deployment-id}"
  },
  "deployment:update": {
    "href": "/restapis/{restapi-id}/deployments/{deployment-id}"
  }
},
"apiSummary": {
  "/petstorewalkthrough/pets/{petId}": {
    "GET": {
      "apiKeyRequired": false,
      "authorizationType": "NONE"
    }
  },
  "/mydemoawsproxy": {
    "GET": {
      "apiKeyRequired": false,
      "authorizationType": "NONE"
    }
  }
},
"createdDate": "2016-02-12T22:20:25Z",
"id": "{deployment-id}"
}
```

## See Also
<a name="API_GetDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetDeployment) 

# GetDeployments
<a name="API_GetDeployments"></a>

Gets information about a Deployments collection.

## Request Syntax
<a name="API_GetDeployments_RequestSyntax"></a>

```
GET /restapis/restapi_id/deployments?limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDeployments_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetDeployments_RequestSyntax) **   <a name="apigw-GetDeployments-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetDeployments_RequestSyntax) **   <a name="apigw-GetDeployments-request-uri-position"></a>
The current pagination position in the paged result set.

 ** [restapi\$1id](#API_GetDeployments_RequestSyntax) **   <a name="apigw-GetDeployments-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetDeployments_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDeployments_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "apiSummary": { 
            "string" : { 
               "string" : { 
                  "apiKeyRequired": boolean,
                  "authorizationType": "string"
               }
            }
         },
         "createdDate": number,
         "description": "string",
         "id": "string"
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetDeployments_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetDeployments_ResponseSyntax) **   <a name="apigw-GetDeployments-response-item"></a>
The current page of elements from this collection.  
Type: Array of [Deployment](API_Deployment.md) objects

 ** [position](#API_GetDeployments_ResponseSyntax) **   <a name="apigw-GetDeployments-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetDeployments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** ServiceUnavailableException **   
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.  
HTTP Status Code: 503

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetDeployments_Examples"></a>

### Get the deployments of an API
<a name="API_GetDeployments_Example_1"></a>

This example illustrates one usage of GetDeployments.

#### Sample Request
<a name="API_GetDeployments_Example_1_Request"></a>

```
GET /restapis/fugvjdxtri/deployments?limit=2 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160606T222635Z
Authorization: AWS4-HMAC-SHA256 Credential={secrete_key}/20160606/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
```

#### Sample Response
<a name="API_GetDeployments_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-deployment-{rel}.html",
      "name": "deployment",
      "templated": true
    },
    "self": {
      "href": "/restapis/fugvjdxtri/deployments?limit=2"
    },
    "deployment:by-id": {
      "href": "/restapis/fugvjdxtri/deployments/{deployment_id}{?embed}",
      "templated": true
    },
    "deployment:create": {
      "href": "/restapis/fugvjdxtri/deployments"
    },
    "item": [
      {
        "href": "/restapis/fugvjdxtri/deployments/4vvti6"
      },
      {
        "href": "/restapis/fugvjdxtri/deployments/a9kdln"
      }
    ],
    "next": {
      "href": "/restapis/fugvjdxtri/deployments?position=aWQ9U2E5a2Rsbg%3D%3D&limit=2"
    }
  },
  "_embedded": {
    "item": [
      {
        "_links": {
          "self": {
            "href": "/restapis/fugvjdxtri/deployments/4vvti6"
          },
          "deployment:delete": {
            "href": "/restapis/fugvjdxtri/deployments/4vvti6"
          },
          "deployment:stages": {
            "href": "/restapis/fugvjdxtri/stages?deployment_id=4vvti6"
          },
          "deployment:update": {
            "href": "/restapis/fugvjdxtri/deployments/4vvti6"
          }
        },
        "createdDate": "2016-06-06T17:42:37Z",
        "id": "4vvti6"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/fugvjdxtri/deployments/a9kdln"
          },
          "deployment:delete": {
            "href": "/restapis/fugvjdxtri/deployments/a9kdln"
          },
          "deployment:stages": {
            "href": "/restapis/fugvjdxtri/stages?deployment_id=a9kdln"
          },
          "deployment:update": {
            "href": "/restapis/fugvjdxtri/deployments/a9kdln"
          }
        },
        "createdDate": "2016-06-06T22:18:22Z",
        "description": "stage2 deploy2",
        "id": "a9kdln"
      }
    ]
  }
}
```

## See Also
<a name="API_GetDeployments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetDeployments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetDeployments) 

# GetDocumentationPart
<a name="API_GetDocumentationPart"></a>

Gets a documentation part.

## Request Syntax
<a name="API_GetDocumentationPart_RequestSyntax"></a>

```
GET /restapis/restapi_id/documentation/parts/part_id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDocumentationPart_RequestParameters"></a>

The request uses the following URI parameters.

 ** [part\$1id](#API_GetDocumentationPart_RequestSyntax) **   <a name="apigw-GetDocumentationPart-request-uri-documentationPartId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [restapi\$1id](#API_GetDocumentationPart_RequestSyntax) **   <a name="apigw-GetDocumentationPart-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetDocumentationPart_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDocumentationPart_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "id": "string",
   "location": { 
      "method": "string",
      "name": "string",
      "path": "string",
      "statusCode": "string",
      "type": "string"
   },
   "properties": "string"
}
```

## Response Elements
<a name="API_GetDocumentationPart_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [id](#API_GetDocumentationPart_ResponseSyntax) **   <a name="apigw-GetDocumentationPart-response-id"></a>
The DocumentationPart identifier, generated by API Gateway when the `DocumentationPart` is created.  
Type: String

 ** [location](#API_GetDocumentationPart_ResponseSyntax) **   <a name="apigw-GetDocumentationPart-response-location"></a>
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.  
Type: [DocumentationPartLocation](API_DocumentationPartLocation.md) object

 ** [properties](#API_GetDocumentationPart_ResponseSyntax) **   <a name="apigw-GetDocumentationPart-response-properties"></a>
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 OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of `x-amazon-apigateway-documentation`.  
Type: String

## Errors
<a name="API_GetDocumentationPart_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetDocumentationPart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetDocumentationPart) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetDocumentationPart) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetDocumentationPart) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetDocumentationPart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetDocumentationPart) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetDocumentationPart) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetDocumentationPart) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetDocumentationPart) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetDocumentationPart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetDocumentationPart) 

# GetDocumentationParts
<a name="API_GetDocumentationParts"></a>

Gets documentation parts.

## Request Syntax
<a name="API_GetDocumentationParts_RequestSyntax"></a>

```
GET /restapis/restapi_id/documentation/parts?limit=limit&locationStatus=locationStatus&name=nameQuery&path=path&position=position&type=type HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDocumentationParts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetDocumentationParts_RequestSyntax) **   <a name="apigw-GetDocumentationParts-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [locationStatus](#API_GetDocumentationParts_RequestSyntax) **   <a name="apigw-GetDocumentationParts-request-uri-locationStatus"></a>
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.  
Valid Values: `DOCUMENTED | UNDOCUMENTED` 

 ** [nameQuery](#API_GetDocumentationParts_RequestSyntax) **   <a name="apigw-GetDocumentationParts-request-uri-nameQuery"></a>
The name of API entities of the to-be-retrieved documentation parts.

 ** [path](#API_GetDocumentationParts_RequestSyntax) **   <a name="apigw-GetDocumentationParts-request-uri-path"></a>
The path of API entities of the to-be-retrieved documentation parts.

 ** [position](#API_GetDocumentationParts_RequestSyntax) **   <a name="apigw-GetDocumentationParts-request-uri-position"></a>
The current pagination position in the paged result set.

 ** [restapi\$1id](#API_GetDocumentationParts_RequestSyntax) **   <a name="apigw-GetDocumentationParts-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [type](#API_GetDocumentationParts_RequestSyntax) **   <a name="apigw-GetDocumentationParts-request-uri-type"></a>
The type of API entities of the to-be-retrieved documentation parts.   
Valid Values: `API | AUTHORIZER | MODEL | RESOURCE | METHOD | PATH_PARAMETER | QUERY_PARAMETER | REQUEST_HEADER | REQUEST_BODY | RESPONSE | RESPONSE_HEADER | RESPONSE_BODY` 

## Request Body
<a name="API_GetDocumentationParts_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDocumentationParts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "id": "string",
         "location": { 
            "method": "string",
            "name": "string",
            "path": "string",
            "statusCode": "string",
            "type": "string"
         },
         "properties": "string"
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetDocumentationParts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetDocumentationParts_ResponseSyntax) **   <a name="apigw-GetDocumentationParts-response-item"></a>
The current page of elements from this collection.  
Type: Array of [DocumentationPart](API_DocumentationPart.md) objects

 ** [position](#API_GetDocumentationParts_ResponseSyntax) **   <a name="apigw-GetDocumentationParts-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetDocumentationParts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetDocumentationParts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetDocumentationParts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetDocumentationParts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetDocumentationParts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetDocumentationParts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetDocumentationParts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetDocumentationParts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetDocumentationParts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetDocumentationParts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetDocumentationParts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetDocumentationParts) 

# GetDocumentationVersion
<a name="API_GetDocumentationVersion"></a>

Gets a documentation version.

## Request Syntax
<a name="API_GetDocumentationVersion_RequestSyntax"></a>

```
GET /restapis/restapi_id/documentation/versions/doc_version HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDocumentationVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [doc\$1version](#API_GetDocumentationVersion_RequestSyntax) **   <a name="apigw-GetDocumentationVersion-request-uri-documentationVersion"></a>
The version identifier of the to-be-retrieved documentation snapshot.  
Required: Yes

 ** [restapi\$1id](#API_GetDocumentationVersion_RequestSyntax) **   <a name="apigw-GetDocumentationVersion-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetDocumentationVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDocumentationVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdDate": number,
   "description": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_GetDocumentationVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdDate](#API_GetDocumentationVersion_ResponseSyntax) **   <a name="apigw-GetDocumentationVersion-response-createdDate"></a>
The date when the API documentation snapshot is created.  
Type: Timestamp

 ** [description](#API_GetDocumentationVersion_ResponseSyntax) **   <a name="apigw-GetDocumentationVersion-response-description"></a>
The description of the API documentation snapshot.  
Type: String

 ** [version](#API_GetDocumentationVersion_ResponseSyntax) **   <a name="apigw-GetDocumentationVersion-response-version"></a>
The version identifier of the API documentation snapshot.  
Type: String

## Errors
<a name="API_GetDocumentationVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetDocumentationVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetDocumentationVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetDocumentationVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetDocumentationVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetDocumentationVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetDocumentationVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetDocumentationVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetDocumentationVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetDocumentationVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetDocumentationVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetDocumentationVersion) 

# GetDocumentationVersions
<a name="API_GetDocumentationVersions"></a>

Gets documentation versions.

## Request Syntax
<a name="API_GetDocumentationVersions_RequestSyntax"></a>

```
GET /restapis/restapi_id/documentation/versions?limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDocumentationVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetDocumentationVersions_RequestSyntax) **   <a name="apigw-GetDocumentationVersions-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetDocumentationVersions_RequestSyntax) **   <a name="apigw-GetDocumentationVersions-request-uri-position"></a>
The current pagination position in the paged result set.

 ** [restapi\$1id](#API_GetDocumentationVersions_RequestSyntax) **   <a name="apigw-GetDocumentationVersions-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetDocumentationVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDocumentationVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "createdDate": number,
         "description": "string",
         "version": "string"
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetDocumentationVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetDocumentationVersions_ResponseSyntax) **   <a name="apigw-GetDocumentationVersions-response-item"></a>
The current page of elements from this collection.  
Type: Array of [DocumentationVersion](API_DocumentationVersion.md) objects

 ** [position](#API_GetDocumentationVersions_ResponseSyntax) **   <a name="apigw-GetDocumentationVersions-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetDocumentationVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetDocumentationVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetDocumentationVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetDocumentationVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetDocumentationVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetDocumentationVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetDocumentationVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetDocumentationVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetDocumentationVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetDocumentationVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetDocumentationVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetDocumentationVersions) 

# GetDomainName
<a name="API_GetDomainName"></a>

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

## Request Syntax
<a name="API_GetDomainName_RequestSyntax"></a>

```
GET /domainnames/domain_name?domainNameId=domainNameId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDomainName_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domain\$1name](#API_GetDomainName_RequestSyntax) **   <a name="apigw-GetDomainName-request-uri-domainName"></a>
The name of the DomainName resource.  
Required: Yes

 ** [domainNameId](#API_GetDomainName_RequestSyntax) **   <a name="apigw-GetDomainName-request-uri-domainNameId"></a>
 The identifier for the domain name resource. Required for private custom domain names. 

## Request Body
<a name="API_GetDomainName_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDomainName_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "certificateArn": "string",
   "certificateName": "string",
   "certificateUploadDate": number,
   "distributionDomainName": "string",
   "distributionHostedZoneId": "string",
   "domainName": "string",
   "domainNameArn": "string",
   "domainNameId": "string",
   "domainNameStatus": "string",
   "domainNameStatusMessage": "string",
   "endpointAccessMode": "string",
   "endpointConfiguration": { 
      "ipAddressType": "string",
      "types": [ "string" ],
      "vpcEndpointIds": [ "string" ]
   },
   "managementPolicy": "string",
   "mutualTlsAuthentication": { 
      "truststoreUri": "string",
      "truststoreVersion": "string",
      "truststoreWarnings": [ "string" ]
   },
   "ownershipVerificationCertificateArn": "string",
   "policy": "string",
   "regionalCertificateArn": "string",
   "regionalCertificateName": "string",
   "regionalDomainName": "string",
   "regionalHostedZoneId": "string",
   "routingMode": "string",
   "securityPolicy": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetDomainName_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [certificateArn](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-certificateArn"></a>
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. AWS Certificate Manager is the only supported source.  
Type: String

 ** [certificateName](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-certificateName"></a>
The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.  
Type: String

 ** [certificateUploadDate](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-certificateUploadDate"></a>
The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.  
Type: Timestamp

 ** [distributionDomainName](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-distributionDomainName"></a>
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.  
Type: String

 ** [distributionHostedZoneId](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-distributionHostedZoneId"></a>
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.   
Type: String

 ** [domainName](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-domainName"></a>
The custom domain name as an API host name, for example, `my-api.example.com`.  
Type: String

 ** [domainNameArn](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-domainNameArn"></a>
The ARN of the domain name.   
Type: String

 ** [domainNameId](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-domainNameId"></a>
The identifier for the domain name resource. Supported only for private custom domain names.  
Type: String

 ** [domainNameStatus](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-domainNameStatus"></a>
The status of the DomainName migration. The valid values are `AVAILABLE` and `UPDATING`. If the status is `UPDATING`, the domain cannot be modified further until the existing operation is complete. If it is `AVAILABLE`, the domain can be updated.  
Type: String  
Valid Values: `AVAILABLE | UPDATING | PENDING | PENDING_CERTIFICATE_REIMPORT | PENDING_OWNERSHIP_VERIFICATION | FAILED` 

 ** [domainNameStatusMessage](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-domainNameStatusMessage"></a>
An optional text message containing detailed information about status of the DomainName migration.  
Type: String

 ** [endpointAccessMode](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-endpointAccessMode"></a>
 The endpoint access mode of the DomainName.   
Type: String  
Valid Values: `BASIC | STRICT` 

 ** [endpointConfiguration](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-endpointConfiguration"></a>
The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.   
Type: [EndpointConfiguration](API_EndpointConfiguration.md) object

 ** [managementPolicy](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-managementPolicy"></a>
A stringified JSON policy document that applies to the API Gateway Management service for this DomainName. This policy document controls access for access association sources to create domain name access associations with this DomainName. Supported only for private custom domain names.  
Type: String

 ** [mutualTlsAuthentication](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-mutualTlsAuthentication"></a>
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.  
Type: [MutualTlsAuthentication](API_MutualTlsAuthentication.md) object

 ** [ownershipVerificationCertificateArn](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-ownershipVerificationCertificateArn"></a>
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.  
Type: String

 ** [policy](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-policy"></a>
A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.  
Type: String

 ** [regionalCertificateArn](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-regionalCertificateArn"></a>
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.  
Type: String

 ** [regionalCertificateName](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-regionalCertificateName"></a>
The name of the certificate that will be used for validating the regional domain name.  
Type: String

 ** [regionalDomainName](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-regionalDomainName"></a>
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.  
Type: String

 ** [regionalHostedZoneId](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-regionalHostedZoneId"></a>
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.   
Type: String

 ** [routingMode](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-routingMode"></a>
The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your APIs.  
Type: String  
Valid Values: `BASE_PATH_MAPPING_ONLY | ROUTING_RULE_ONLY | ROUTING_RULE_THEN_BASE_PATH_MAPPING` 

 ** [securityPolicy](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-securityPolicy"></a>
The Transport Layer Security (TLS) version \$1 cipher suite for this DomainName.  
Type: String  
Valid Values: `TLS_1_0 | TLS_1_2 | SecurityPolicy_TLS13_1_3_2025_09 | SecurityPolicy_TLS13_1_3_FIPS_2025_09 | SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_PQ_2025_09 | SecurityPolicy_TLS13_1_2_2021_06 | SecurityPolicy_TLS13_2025_EDGE | SecurityPolicy_TLS12_PFS_2025_EDGE | SecurityPolicy_TLS12_2018_EDGE` 

 ** [tags](#API_GetDomainName_ResponseSyntax) **   <a name="apigw-GetDomainName-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

## Errors
<a name="API_GetDomainName_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetDomainName_Examples"></a>

### Get a information about a DomainName
<a name="API_GetDomainName_Example_1"></a>

This example illustrates one usage of GetDomainName.

#### Sample Request
<a name="API_GetDomainName_Example_1_Request"></a>

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

#### Sample Response
<a name="API_GetDomainName_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-basepathmapping-{rel}.html",
        "name": "basepathmapping",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-domainname-{rel}.html",
        "name": "domainname",
        "templated": true
      }
    ],
    "self": {
      "href": "/domainnames/a.b.c.com"
    },
    "basepathmapping:by-base-path": {
      "href": "/domainnames/a.b.c.com/basepathmappings/{base_path}",
      "templated": true
    },
    "basepathmapping:create": {
      "href": "/domainnames/a.b.c.com/basepathmappings"
    },
    "domainname:basepathmappings": {
      "href": "/domainnames/a.b.c.com/basepathmappings{?limit}",
      "templated": true
    },
    "domainname:delete": {
      "href": "/domainnames/a.b.c.com"
    },
    "domainname:update": {
      "href": "/domainnames/a.b.c.com"
    }
  },
  "certificateName": "test",
  "certificateArn": "arn:aws:acm:us-east-1:012345678910:certificate/certificate_id",
  "certificateUploadDate": "2016-04-18T22:16:04Z",
  "distributionDomainName": "d3ih7ecqtec0mt.cloudfront.net",
  "domainName": "a.b.c.com"
}
```

### Get a information about a DomainName with an endpoint type of private
<a name="API_GetDomainName_Example_2"></a>

This example illustrates one usage of GetDomainName.

#### Sample Request
<a name="API_GetDomainName_Example_2_Request"></a>

```
GET /domainnames/private.a.b.c.com?domainNameId=abcd1234 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160602T000654Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160602/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
```

#### Sample Response
<a name="API_GetDomainName_Example_2_Response"></a>

```
{
  "_links": {
      "curies": [
          {
              "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-basepathmapping-{rel}.html",
              "name": "basepathmapping",
              "templated": true
          },
          {
              "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-domainname-{rel}.html",
              "name": "domainname",
              "templated": true
          }
      ],
      "self": {
          "href": "/domainnames/private.a.b.c.com?domainNameId=abcd1234"
      },
     "basepathmapping:by-base-path": {
          "href": "/domainnames/private.a.b.c.com/basepathmappings/{base_path}?domainNameId=abcd1234",
          "templated": true
      },
      "basepathmapping:create": {
          "href": "/domainnames/private.a.b.c.com/basepathmappings?domainNameId=abcd1234"
      },
      "domainname:basepathmappings": {
          "href": "/domainnames/private.a.b.c.com/basepathmappings?domainNameId=abcd1234{&limit}",
          "templated": true
      },
      "domainname:delete": {
          "href": "/domainnames/private.a.b.c.com?domainNameId=abcd1234"
      },
      "domainname:update": {
          "href": "/domainnames/private.a.b.c.com?domainNameId=abcd1234"
      }
  },
  "certificateArn": "arn:aws:acm:us-east-1:012345678910:certificate/certificate_id",
  "certificateUploadDate": "2024-10-28T17:57:00Z",
  "domainName": "private.a.b.c.com",
  "domainNameArn": "arn:aws:apigateway:us-east-1:012345678910:/domainnames/a.b.c.com+abcd1234",
  "domainNameId": "abcd1234",
  "domainNameStatus": "AVAILABLE",
  "endpointConfiguration": {
      "vpcEndpointIds": null,
      "types": "PRIVATE",
  },
  "policy": "..."
  "securityPolicy": "TLS_1_2",
  "tags": {}
}
```

## See Also
<a name="API_GetDomainName_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetDomainName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetDomainName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetDomainName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetDomainName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetDomainName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetDomainName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetDomainName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetDomainName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetDomainName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetDomainName) 

# GetDomainNameAccessAssociations
<a name="API_GetDomainNameAccessAssociations"></a>

Represents a collection on DomainNameAccessAssociations resources.

## Request Syntax
<a name="API_GetDomainNameAccessAssociations_RequestSyntax"></a>

```
GET /domainnameaccessassociations?limit=limit&position=position&resourceOwner=resourceOwner HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDomainNameAccessAssociations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetDomainNameAccessAssociations_RequestSyntax) **   <a name="apigw-GetDomainNameAccessAssociations-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. 

 ** [position](#API_GetDomainNameAccessAssociations_RequestSyntax) **   <a name="apigw-GetDomainNameAccessAssociations-request-uri-position"></a>
The current pagination position in the paged result set. 

 ** [resourceOwner](#API_GetDomainNameAccessAssociations_RequestSyntax) **   <a name="apigw-GetDomainNameAccessAssociations-request-uri-resourceOwner"></a>
 The owner of the domain name access association. Use `SELF` to only list the domain name access associations owned by your own account. Use `OTHER_ACCOUNTS` to list the domain name access associations with your private custom domain names that are owned by other AWS accounts.  
Valid Values: `SELF | OTHER_ACCOUNTS` 

## Request Body
<a name="API_GetDomainNameAccessAssociations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDomainNameAccessAssociations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "accessAssociationSource": "string",
         "accessAssociationSourceType": "string",
         "domainNameAccessAssociationArn": "string",
         "domainNameArn": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetDomainNameAccessAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetDomainNameAccessAssociations_ResponseSyntax) **   <a name="apigw-GetDomainNameAccessAssociations-response-item"></a>
 The current page of elements from this collection.   
Type: Array of [DomainNameAccessAssociation](API_DomainNameAccessAssociation.md) objects

 ** [position](#API_GetDomainNameAccessAssociations_ResponseSyntax) **   <a name="apigw-GetDomainNameAccessAssociations-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetDomainNameAccessAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetDomainNameAccessAssociations_Examples"></a>

### Get the domain name access associations for domain name access associations owned by your own account
<a name="API_GetDomainNameAccessAssociations_Example_1"></a>

This example illustrates one usage of GetDomainNameAccessAssociations.

```
GET /domainnameaccessassociations?limit=10&resourceOwner=SELF
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160601T173728Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160601/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
```

#### Sample Response
<a name="API_GetDomainNameAccessAssociations_Example_1_Response"></a>

```
{
    "_links": {
        "curies": {
            "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/domainnameaccessassociation-domainname-{rel}.html",
            "name": "domainnameaccessassociation",
            "templated": true
        },
        "self": {
            "href": "/domainnameaccessassociations?limit=10"
        },
        "domainnameaccessassociation:create": {
            "href": "/domainnameaccessassociations"
        },
        "item": {
            "href": "/domainnameaccessassociations/arn:aws:apigateway:us-east-1:012345678910:/domainnameaccessassociations/domainname/private.a.b.c.com+abcd1234/vpcesource/vpce-abcd1234"
        }
    },
    "_embedded": {
        "item": {
            "_links": {
                "self": {
                    "href": "/domainnameaccessassociations/arn:aws:apigateway:us-east-1:012345678910:/domainnameaccessassociations/domainname/private.a.b.c.com+abcd1234/vpcesource/vpce-abcd1234"
                }
            },
            "accessAssociationSource": "vpce-abcd1234",
            "accessAssociationSourceType": "VPCE",
            "domainNameAccessAssociationArn": "arn:aws:apigateway:us-east-1:012345678910:/domainnameaccessassociations/domainname/private.a.b.c.com+abcd1234/vpcesource/vpce-abcd1234",
            "domainNameArn": "arn:aws:apigateway:us-east-1:012345678910:/domainnames/private.a.b.c.com+abcd1234"
        }
    }
}
```

## See Also
<a name="API_GetDomainNameAccessAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetDomainNameAccessAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetDomainNameAccessAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetDomainNameAccessAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetDomainNameAccessAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetDomainNameAccessAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetDomainNameAccessAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetDomainNameAccessAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetDomainNameAccessAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetDomainNameAccessAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetDomainNameAccessAssociations) 

# GetDomainNames
<a name="API_GetDomainNames"></a>

Represents a collection of DomainName resources.

## Request Syntax
<a name="API_GetDomainNames_RequestSyntax"></a>

```
GET /domainnames?limit=limit&position=position&resourceOwner=resourceOwner HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDomainNames_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetDomainNames_RequestSyntax) **   <a name="apigw-GetDomainNames-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetDomainNames_RequestSyntax) **   <a name="apigw-GetDomainNames-request-uri-position"></a>
The current pagination position in the paged result set.

 ** [resourceOwner](#API_GetDomainNames_RequestSyntax) **   <a name="apigw-GetDomainNames-request-uri-resourceOwner"></a>
The owner of the domain name.   
Valid Values: `SELF | OTHER_ACCOUNTS` 

## Request Body
<a name="API_GetDomainNames_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDomainNames_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "certificateArn": "string",
         "certificateName": "string",
         "certificateUploadDate": number,
         "distributionDomainName": "string",
         "distributionHostedZoneId": "string",
         "domainName": "string",
         "domainNameArn": "string",
         "domainNameId": "string",
         "domainNameStatus": "string",
         "domainNameStatusMessage": "string",
         "endpointAccessMode": "string",
         "endpointConfiguration": { 
            "ipAddressType": "string",
            "types": [ "string" ],
            "vpcEndpointIds": [ "string" ]
         },
         "managementPolicy": "string",
         "mutualTlsAuthentication": { 
            "truststoreUri": "string",
            "truststoreVersion": "string",
            "truststoreWarnings": [ "string" ]
         },
         "ownershipVerificationCertificateArn": "string",
         "policy": "string",
         "regionalCertificateArn": "string",
         "regionalCertificateName": "string",
         "regionalDomainName": "string",
         "regionalHostedZoneId": "string",
         "routingMode": "string",
         "securityPolicy": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetDomainNames_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetDomainNames_ResponseSyntax) **   <a name="apigw-GetDomainNames-response-item"></a>
The current page of elements from this collection.  
Type: Array of [DomainName](API_DomainName.md) objects

 ** [position](#API_GetDomainNames_ResponseSyntax) **   <a name="apigw-GetDomainNames-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetDomainNames_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetDomainNames_Examples"></a>

### Retrieve domain names
<a name="API_GetDomainNames_Example_1"></a>

The following example request retrieves up to 10 custom DomainName resources for APIs under the caller's AWS account. 

 A successful response returns the requested `DomainName` resources that can be navigated to by following the linked item or examining the embedded item resource. 

#### Sample Request
<a name="API_GetDomainNames_Example_1_Request"></a>

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

#### Sample Response
<a name="API_GetDomainNames_Example_1_Response"></a>

```
{
    "_links": {
        "curies": [
            {
                "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-basepathmapping-{rel}.html",
                "name": "basepathmapping",
                "templated": true
            },
            {
                "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-domainname-{rel}.html",
                "name": "domainname",
                "templated": true
            }
        ],
        "self": {
            "href": "/domainnames?limit=10"
        },
        "domainname:by-name": {
            "href": "/domainnames/{domain_name}{?domain_name_id}",
            "templated": true
        },
        "domainname:create": {
            "href": "/domainnames"
        },
        "item": [
            {
                "href": "/domainnames/a.b.c.com"
            },
            {
                "href": "/domainnames/private.a.b.c.com?domain_name_id=a1b2c3"
            }
        ]
    },
    "_embedded": {
        "item": [
            {
                "_links": {
                    "self": {
                        "href": "/domainnames/a.b.c.com"
                    },
                    "basepathmapping:by-base-path": {
                        "href": "/domainnames/a.b.c.com/basepathmappings/{base_path}",
                        "templated": true
                    },
                    "basepathmapping:create": {
                        "href": "/domainnames/a.b.c.com/basepathmappings"
                    },
                    "domainname:basepathmappings": {
                        "href":  "/domainnames/a.b.c.com/basepathmappings{?limit}",,
                        "templated": true
                    },
                    "domainname:delete": {
                        "href": "/domainnames/a.b.c.com"
                    },
                    "domainname:update": {
                        "href": "/domainnames/a.b.c.com"
                    }
                },
                "certificateArn": "arn:aws:acm:us-east-1:012345678910:certificate/abcdef",
                "certificateUploadDate": "2016-04-18T22:16:04Z",
                "distributionDomainName": "d3ih7ecqtec0mt.cloudfront.net",
                "domainName": "a.b.c.com"
            },
            {
                "_links": {
                    "self": {
                        "href": "/domainnames/private.a.b.c.com?domain_name_id=a1b2c3"
                    },
                    "basepathmapping:by-base-path": {
                        "href": "/domainnames/prviate.a.b.c.com/basepathmappings/{base_path}?domain_name_id=a1b2c3",
                        "templated": true
                    },
                    "basepathmapping:create": {
                        "href": "/domainnames/private.a.b.c.com/basepathmappings?domain_name_id=a1b2c3"
                    },
                    "domainname:basepathmappings": {
                        "href": "/domainnames/private.a.b.c.com/basepathmappings?domain_name_id=a1b2c3{&limit}",
                        "templated": true
                    },
                    "domainname:delete": {
                        "href": "/domainnames/private.a.b.c.com?domain_name_id=a1b2c3"
                    },
                    "domainname:update": {
                        "href": "/domainnames/private.a.b.c.com?domain_name_id=a1b2c3"
                    }
                },
                "certificateArn": "arn:aws:acm:us-west-2:012345678910:certificate/aaaaaaa",
                "certificateUploadDate": "2024-09-19T21:51:28Z",
                "domainName": "private.a.b.c.com",
                "domainNameArn": "arn:aws:apigateway:us-west-2:012345678910:/domainnames/private.a.b.c.com+a1b2c3",
                "domainNameId": "a1b2c3",
                "domainNameStatus": "AVAILABLE",
                "endpointConfiguration": {
                    "vpcEndpointIds": null,
                    "types": "PRIVATE"
                },
                "securityPolicy": "TLS_1_2"
            }
        ]
    }
}
```

## See Also
<a name="API_GetDomainNames_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetDomainNames) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetDomainNames) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetDomainNames) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetDomainNames) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetDomainNames) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetDomainNames) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetDomainNames) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetDomainNames) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetDomainNames) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetDomainNames) 

# GetExport
<a name="API_GetExport"></a>

Exports a deployed version of a RestApi in a specified format.

## Request Syntax
<a name="API_GetExport_RequestSyntax"></a>

```
GET /restapis/restapi_id/stages/stage_name/exports/export_type?parameters HTTP/1.1
Accept: accepts
```

## URI Request Parameters
<a name="API_GetExport_RequestParameters"></a>

The request uses the following URI parameters.

 ** [accepts](#API_GetExport_RequestSyntax) **   <a name="apigw-GetExport-request-accepts"></a>
The content-type of the export, for example `application/json`. Currently `application/json` and `application/yaml` are supported for `exportType` of`oas30` and `swagger`. This should be specified in the `Accept` header for direct API requests.

 ** [export\$1type](#API_GetExport_RequestSyntax) **   <a name="apigw-GetExport-request-uri-exportType"></a>
The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.  
Required: Yes

 ** [parameters](#API_GetExport_RequestSyntax) **   <a name="apigw-GetExport-request-uri-parameters"></a>
A key-value map of query string parameters that specify properties of the export, depending on the requested `exportType`. For `exportType` `oas30` and `swagger`, any combination of the following parameters are supported: `extensions='integrations'` or `extensions='apigateway'` will export the API with x-amazon-apigateway-integration extensions. `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

 ** [restapi\$1id](#API_GetExport_RequestSyntax) **   <a name="apigw-GetExport-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [stage\$1name](#API_GetExport_RequestSyntax) **   <a name="apigw-GetExport-request-uri-stageName"></a>
The name of the Stage that will be exported.  
Required: Yes

## Request Body
<a name="API_GetExport_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetExport_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-Type: contentType
Content-Disposition: contentDisposition

body
```

## Response Elements
<a name="API_GetExport_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

 ** [contentDisposition](#API_GetExport_ResponseSyntax) **   <a name="apigw-GetExport-response-contentDisposition"></a>
The content-disposition header value in the HTTP response.

 ** [contentType](#API_GetExport_ResponseSyntax) **   <a name="apigw-GetExport-response-contentType"></a>
The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.

The response returns the following as the HTTP body.

 ** [body](#API_GetExport_ResponseSyntax) **   <a name="apigw-GetExport-response-body"></a>
The binary blob response to GetExport, which contains the export.

## Errors
<a name="API_GetExport_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetExport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetExport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetExport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetExport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetExport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetExport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetExport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetExport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetExport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetExport) 

# GetGatewayResponse
<a name="API_GetGatewayResponse"></a>

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

## Request Syntax
<a name="API_GetGatewayResponse_RequestSyntax"></a>

```
GET /restapis/restapi_id/gatewayresponses/response_type HTTP/1.1
```

## URI Request Parameters
<a name="API_GetGatewayResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [response\$1type](#API_GetGatewayResponse_RequestSyntax) **   <a name="apigw-GetGatewayResponse-request-uri-responseType"></a>
The response type of the associated GatewayResponse.  
Valid Values: `DEFAULT_4XX | DEFAULT_5XX | RESOURCE_NOT_FOUND | UNAUTHORIZED | INVALID_API_KEY | ACCESS_DENIED | AUTHORIZER_FAILURE | AUTHORIZER_CONFIGURATION_ERROR | INVALID_SIGNATURE | EXPIRED_TOKEN | MISSING_AUTHENTICATION_TOKEN | INTEGRATION_FAILURE | INTEGRATION_TIMEOUT | API_CONFIGURATION_ERROR | UNSUPPORTED_MEDIA_TYPE | BAD_REQUEST_PARAMETERS | BAD_REQUEST_BODY | REQUEST_TOO_LARGE | THROTTLED | QUOTA_EXCEEDED | WAF_FILTERED`   
Required: Yes

 ** [restapi\$1id](#API_GetGatewayResponse_RequestSyntax) **   <a name="apigw-GetGatewayResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetGatewayResponse_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetGatewayResponse_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "defaultResponse": boolean,
   "responseParameters": { 
      "string" : "string" 
   },
   "responseTemplates": { 
      "string" : "string" 
   },
   "responseType": "string",
   "statusCode": "string"
}
```

## Response Elements
<a name="API_GetGatewayResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [defaultResponse](#API_GetGatewayResponse_ResponseSyntax) **   <a name="apigw-GetGatewayResponse-response-defaultResponse"></a>
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.   
Type: Boolean

 ** [responseParameters](#API_GetGatewayResponse_ResponseSyntax) **   <a name="apigw-GetGatewayResponse-response-responseParameters"></a>
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.  
Type: String to string map

 ** [responseTemplates](#API_GetGatewayResponse_ResponseSyntax) **   <a name="apigw-GetGatewayResponse-response-responseTemplates"></a>
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.  
Type: String to string map

 ** [responseType](#API_GetGatewayResponse_ResponseSyntax) **   <a name="apigw-GetGatewayResponse-response-responseType"></a>
The response type of the associated GatewayResponse.  
Type: String  
Valid Values: `DEFAULT_4XX | DEFAULT_5XX | RESOURCE_NOT_FOUND | UNAUTHORIZED | INVALID_API_KEY | ACCESS_DENIED | AUTHORIZER_FAILURE | AUTHORIZER_CONFIGURATION_ERROR | INVALID_SIGNATURE | EXPIRED_TOKEN | MISSING_AUTHENTICATION_TOKEN | INTEGRATION_FAILURE | INTEGRATION_TIMEOUT | API_CONFIGURATION_ERROR | UNSUPPORTED_MEDIA_TYPE | BAD_REQUEST_PARAMETERS | BAD_REQUEST_BODY | REQUEST_TOO_LARGE | THROTTLED | QUOTA_EXCEEDED | WAF_FILTERED` 

 ** [statusCode](#API_GetGatewayResponse_ResponseSyntax) **   <a name="apigw-GetGatewayResponse-response-statusCode"></a>
The HTTP status code for this GatewayResponse.  
Type: String  
Pattern: `[1-5]\d\d` 

## Errors
<a name="API_GetGatewayResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetGatewayResponse_Examples"></a>

### Get a Gateway Response of a given response type
<a name="API_GetGatewayResponse_Example_1"></a>

This example illustrates one usage of GetGatewayResponse.

#### Sample Request
<a name="API_GetGatewayResponse_Example_1_Request"></a>

```
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
```

#### Sample Response
<a name="API_GetGatewayResponse_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "http://docs.aws.amazon.com/apigateway/latest/developercguide/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"
}
```

## See Also
<a name="API_GetGatewayResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetGatewayResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetGatewayResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetGatewayResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetGatewayResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetGatewayResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetGatewayResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetGatewayResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetGatewayResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetGatewayResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetGatewayResponse) 

# GetGatewayResponses
<a name="API_GetGatewayResponses"></a>

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.

## Request Syntax
<a name="API_GetGatewayResponses_RequestSyntax"></a>

```
GET /restapis/restapi_id/gatewayresponses?limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetGatewayResponses_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetGatewayResponses_RequestSyntax) **   <a name="apigw-GetGatewayResponses-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

 ** [position](#API_GetGatewayResponses_RequestSyntax) **   <a name="apigw-GetGatewayResponses-request-uri-position"></a>
The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

 ** [restapi\$1id](#API_GetGatewayResponses_RequestSyntax) **   <a name="apigw-GetGatewayResponses-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetGatewayResponses_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetGatewayResponses_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "defaultResponse": boolean,
         "responseParameters": { 
            "string" : "string" 
         },
         "responseTemplates": { 
            "string" : "string" 
         },
         "responseType": "string",
         "statusCode": "string"
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetGatewayResponses_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetGatewayResponses_ResponseSyntax) **   <a name="apigw-GetGatewayResponses-response-item"></a>
Returns the entire collection, because of no pagination support.  
Type: Array of [GatewayResponse](API_GatewayResponse.md) objects

 ** [position](#API_GetGatewayResponses_ResponseSyntax) **   <a name="apigw-GetGatewayResponses-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetGatewayResponses_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetGatewayResponses_Examples"></a>

### Get the collection of gateway responses of an API
<a name="API_GetGatewayResponses_Example_1"></a>

This example illustrates one usage of GetGatewayResponses.

#### Sample Request
<a name="API_GetGatewayResponses_Example_1_Request"></a>

```
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
```

#### Sample Response
<a name="API_GetGatewayResponses_Example_1_Response"></a>

```
{
  "_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"
      },
      {     
        "href": "/restapis/o81lxisefl/gatewayresponses/WAF_FILTERED"
      }
    ]
  },
  "_embedded": {
    "item": [
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "INTEGRATION_FAILURE",
        "statusCode": "504"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "RESOURCE_NOT_FOUND",
        "statusCode": "404"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "REQUEST_TOO_LARGE",
        "statusCode": "413"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "THROTTLED",
        "statusCode": "429"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "UNSUPPORTED_MEDIA_TYPE",
        "statusCode": "415"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "AUTHORIZER_CONFIGURATION_ERROR",
        "statusCode": "500"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "DEFAULT_5XX"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "DEFAULT_4XX"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "BAD_REQUEST_PARAMETERS",
        "statusCode": "400"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "BAD_REQUEST_BODY",
        "statusCode": "400"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "EXPIRED_TOKEN",
        "statusCode": "403"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "ACCESS_DENIED",
        "statusCode": "403"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "INVALID_API_KEY",
        "statusCode": "403"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "UNAUTHORIZED",
        "statusCode": "401"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "API_CONFIGURATION_ERROR",
        "statusCode": "500"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "QUOTA_EXCEEDED",
        "statusCode": "429"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "INTEGRATION_TIMEOUT",
        "statusCode": "504"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "MISSING_AUTHENTICATION_TOKEN",
        "statusCode": "403"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "INVALID_SIGNATURE",
        "statusCode": "403"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "AUTHORIZER_FAILURE",
        "statusCode": "500"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/o81lxisefl/gatewayresponses/WAF_FILTERED"
          },
          "gatewayresponse:put": {
            "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true
          },
          "gatewayresponse:update": {
            "href": "/restapis/o81lxisefl/gatewayresponses/WAF_FILTERED"
          }
        },
        "defaultResponse": true,
        "responseParameters": {},
        "responseTemplates": {
          "application/json": "{\"message\":$context.error.messageString}"
        },
        "responseType": "WAF_FILTERED",
        "statusCode": "403"
      }
    ]
  }
}
```

## See Also
<a name="API_GetGatewayResponses_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetGatewayResponses) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetGatewayResponses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetGatewayResponses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetGatewayResponses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetGatewayResponses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetGatewayResponses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetGatewayResponses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetGatewayResponses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetGatewayResponses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetGatewayResponses) 

# GetIntegration
<a name="API_GetIntegration"></a>

Get the integration settings.

## Request Syntax
<a name="API_GetIntegration_RequestSyntax"></a>

```
GET /restapis/restapi_id/resources/resource_id/methods/http_method/integration HTTP/1.1
```

## URI Request Parameters
<a name="API_GetIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_GetIntegration_RequestSyntax) **   <a name="apigw-GetIntegration-request-uri-httpMethod"></a>
Specifies a get integration request's HTTP method.  
Required: Yes

 ** [resource\$1id](#API_GetIntegration_RequestSyntax) **   <a name="apigw-GetIntegration-request-uri-resourceId"></a>
Specifies a get integration request's resource identifier  
Required: Yes

 ** [restapi\$1id](#API_GetIntegration_RequestSyntax) **   <a name="apigw-GetIntegration-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetIntegration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cacheKeyParameters": [ "string" ],
   "cacheNamespace": "string",
   "connectionId": "string",
   "connectionType": "string",
   "contentHandling": "string",
   "credentials": "string",
   "httpMethod": "string",
   "integrationResponses": { 
      "string" : { 
         "contentHandling": "string",
         "responseParameters": { 
            "string" : "string" 
         },
         "responseTemplates": { 
            "string" : "string" 
         },
         "selectionPattern": "string",
         "statusCode": "string"
      }
   },
   "integrationTarget": "string",
   "passthroughBehavior": "string",
   "requestParameters": { 
      "string" : "string" 
   },
   "requestTemplates": { 
      "string" : "string" 
   },
   "responseTransferMode": "string",
   "timeoutInMillis": number,
   "tlsConfig": { 
      "insecureSkipVerification": boolean
   },
   "type": "string",
   "uri": "string"
}
```

## Response Elements
<a name="API_GetIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cacheKeyParameters](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-cacheKeyParameters"></a>
A list of request parameters whose values API Gateway caches. To be valid values for `cacheKeyParameters`, these parameters must also be specified for Method `requestParameters`.  
Type: Array of strings

 ** [cacheNamespace](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-cacheNamespace"></a>
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the `cacheNamespace`. You can specify the same `cacheNamespace` across resources to return the same cached data for requests to different resources.  
Type: String

 ** [connectionId](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-connectionId"></a>
The ID of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise.  
Type: String

 ** [connectionType](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-connectionType"></a>
The type of the network connection to the integration endpoint. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.  
Type: String  
Valid Values: `INTERNET | VPC_LINK` 

 ** [contentHandling](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-contentHandling"></a>
Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors:  
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass-through.  
Type: String  
Valid Values: `CONVERT_TO_BINARY | CONVERT_TO_TEXT` 

 ** [credentials](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-credentials"></a>
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.  
Type: String

 ** [httpMethod](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-httpMethod"></a>
Specifies the integration's HTTP method type. For the Type property, if you specify `MOCK`, this property is optional. For Lambda integrations, you must set the integration method to `POST`. For all other types, you must specify this property.  
Type: String

 ** [integrationResponses](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-integrationResponses"></a>
Specifies the integration's responses.  
Type: String to [IntegrationResponse](API_IntegrationResponse.md) object map

 ** [integrationTarget](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-integrationTarget"></a>
 The ALB or NLB listener to send the request to.   
Type: String

 ** [passthroughBehavior](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-passthroughBehavior"></a>
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.  
Type: String

 ** [requestParameters](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-requestParameters"></a>
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.  
Type: String to string map

 ** [requestTemplates](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-requestTemplates"></a>
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.  
Type: String to string map

 ** [responseTransferMode](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-responseTransferMode"></a>
 The response transfer mode of the integration.   
Type: String  
Valid Values: `BUFFERED | STREAM` 

 ** [timeoutInMillis](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-timeoutInMillis"></a>
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.  
Type: Integer

 ** [tlsConfig](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-tlsConfig"></a>
Specifies the TLS configuration for an integration.  
Type: [TlsConfig](API_TlsConfig.md) object

 ** [type](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-type"></a>
Specifies an API method integration type. The valid value is one of the following:  
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.  
Type: String  
Valid Values: `HTTP | AWS | MOCK | HTTP_PROXY | AWS_PROXY` 

 ** [uri](#API_GetIntegration_ResponseSyntax) **   <a name="apigw-GetIntegration-response-uri"></a>
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 standard integrations. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name. For `AWS` or `AWS_PROXY` integrations, the URI is of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}`. Here, \$1Region\$1 is the API Gateway region (e.g., us-east-1); \$1service\$1 is the name of the integrated AWS service (e.g., s3); and \$1subdomain\$1 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=\$1name\$1&\$1p1\$1=\$1v1\$1&p2=\$1v2\$1... query string. The ensuing \$1service\$1api\$1 refers to a supported action \$1name\$1 plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service\$1api 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}`   
Type: String

## Errors
<a name="API_GetIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetIntegration_Examples"></a>

### Retrieve information about an Integration
<a name="API_GetIntegration_Example_1"></a>

This example illustrates one usage of GetIntegration.

#### Sample Request
<a name="API_GetIntegration_Example_1_Request"></a>

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

#### Sample Response
<a name="API_GetIntegration_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
        "name": "integration",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
        "name": "integrationresponse",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration"
    },
    "integration:delete": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration"
    },
    "integration:responses": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200",
      "name": "200",
      "title": "200"
    },
    "integration:update": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration"
    },
    "integrationresponse:put": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}",
      "templated": true
    }
  },
  "cacheKeyParameters": [],
  "cacheNamespace": "0cjtch",
  "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole",
  "httpMethod": "POST",
  "passthroughBehavior": "WHEN_NO_MATCH",
  "requestTemplates": {
    "application/json": "{\n    \"a\":  \"$input.params('operand1')\",\n    \"b\":  \"$input.params('operand2')\", \n    \"op\": \"$input.params('operator')\"   \n}"
  },
  "type": "AWS",
  "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations",
  "_embedded": {
    "integration:responses": {
      "_links": {
        "self": {
          "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200",
          "name": "200",
          "title": "200"
        },
        "integrationresponse:delete": {
          "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200"
        },
        "integrationresponse:update": {
          "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200"
        }
      },
      "responseParameters": {
        "method.response.header.operator": "integration.response.body.op",
        "method.response.header.operand_2": "integration.response.body.b",
        "method.response.header.operand_1": "integration.response.body.a"
      },
      "responseTemplates": {
        "application/json": "#set($res = $input.path('$'))\n{\n    \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n  \"a\" : \"$res.a\",\n  \"b\" : \"$res.b\",\n  \"op\" : \"$res.op\",\n  \"c\" : \"$res.c\"\n}"
      },
      "selectionPattern": "",
      "statusCode": "200"
    }
  }
}
```

## See Also
<a name="API_GetIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetIntegration) 

# GetIntegrationResponse
<a name="API_GetIntegrationResponse"></a>

Represents a get integration response.

## Request Syntax
<a name="API_GetIntegrationResponse_RequestSyntax"></a>

```
GET /restapis/restapi_id/resources/resource_id/methods/http_method/integration/responses/status_code HTTP/1.1
```

## URI Request Parameters
<a name="API_GetIntegrationResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_GetIntegrationResponse_RequestSyntax) **   <a name="apigw-GetIntegrationResponse-request-uri-httpMethod"></a>
Specifies a get integration response request's HTTP method.  
Required: Yes

 ** [resource\$1id](#API_GetIntegrationResponse_RequestSyntax) **   <a name="apigw-GetIntegrationResponse-request-uri-resourceId"></a>
Specifies a get integration response request's resource identifier.  
Required: Yes

 ** [restapi\$1id](#API_GetIntegrationResponse_RequestSyntax) **   <a name="apigw-GetIntegrationResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [status\$1code](#API_GetIntegrationResponse_RequestSyntax) **   <a name="apigw-GetIntegrationResponse-request-uri-statusCode"></a>
Specifies a get integration response request's status code.  
Pattern: `[1-5]\d\d`   
Required: Yes

## Request Body
<a name="API_GetIntegrationResponse_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetIntegrationResponse_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contentHandling": "string",
   "responseParameters": { 
      "string" : "string" 
   },
   "responseTemplates": { 
      "string" : "string" 
   },
   "selectionPattern": "string",
   "statusCode": "string"
}
```

## Response Elements
<a name="API_GetIntegrationResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contentHandling](#API_GetIntegrationResponse_ResponseSyntax) **   <a name="apigw-GetIntegrationResponse-response-contentHandling"></a>
Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors:  
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.  
Type: String  
Valid Values: `CONVERT_TO_BINARY | CONVERT_TO_TEXT` 

 ** [responseParameters](#API_GetIntegrationResponse_ResponseSyntax) **   <a name="apigw-GetIntegrationResponse-response-responseParameters"></a>
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.  
Type: String to string map

 ** [responseTemplates](#API_GetIntegrationResponse_ResponseSyntax) **   <a name="apigw-GetIntegrationResponse-response-responseTemplates"></a>
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.  
Type: String to string map

 ** [selectionPattern](#API_GetIntegrationResponse_ResponseSyntax) **   <a name="apigw-GetIntegrationResponse-response-selectionPattern"></a>
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.  
Type: String

 ** [statusCode](#API_GetIntegrationResponse_ResponseSyntax) **   <a name="apigw-GetIntegrationResponse-response-statusCode"></a>
Specifies the status code that is used to map the integration response to an existing MethodResponse.  
Type: String  
Pattern: `[1-5]\d\d` 

## Errors
<a name="API_GetIntegrationResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetIntegrationResponse_Examples"></a>

### Get integration responses of a method
<a name="API_GetIntegrationResponse_Example_1"></a>

This example illustrates one usage of GetIntegrationResponse.

#### Sample Request
<a name="API_GetIntegrationResponse_Example_1_Request"></a>

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

#### Sample Response
<a name="API_GetIntegrationResponse_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
      "name": "integrationresponse",
      "templated": true
    },
    "self": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
      "title": "200"
    },
    "integrationresponse:delete": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
    },
    "integrationresponse:update": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
    }
  },
  "responseParameters": {
    "method.response.header.Content-Type": "'application/xml'"
  },
  "responseTemplates": {
    "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n"
  },
  "statusCode": "200"
}
```

## See Also
<a name="API_GetIntegrationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetIntegrationResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetIntegrationResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetIntegrationResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetIntegrationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetIntegrationResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetIntegrationResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetIntegrationResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetIntegrationResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetIntegrationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetIntegrationResponse) 

# GetMethod
<a name="API_GetMethod"></a>

Describe an existing Method resource.

## Request Syntax
<a name="API_GetMethod_RequestSyntax"></a>

```
GET /restapis/restapi_id/resources/resource_id/methods/http_method HTTP/1.1
```

## URI Request Parameters
<a name="API_GetMethod_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_GetMethod_RequestSyntax) **   <a name="apigw-GetMethod-request-uri-httpMethod"></a>
Specifies the method request's HTTP method type.  
Required: Yes

 ** [resource\$1id](#API_GetMethod_RequestSyntax) **   <a name="apigw-GetMethod-request-uri-resourceId"></a>
The Resource identifier for the Method resource.  
Required: Yes

 ** [restapi\$1id](#API_GetMethod_RequestSyntax) **   <a name="apigw-GetMethod-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetMethod_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetMethod_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "apiKeyRequired": boolean,
   "authorizationScopes": [ "string" ],
   "authorizationType": "string",
   "authorizerId": "string",
   "httpMethod": "string",
   "methodIntegration": { 
      "cacheKeyParameters": [ "string" ],
      "cacheNamespace": "string",
      "connectionId": "string",
      "connectionType": "string",
      "contentHandling": "string",
      "credentials": "string",
      "httpMethod": "string",
      "integrationResponses": { 
         "string" : { 
            "contentHandling": "string",
            "responseParameters": { 
               "string" : "string" 
            },
            "responseTemplates": { 
               "string" : "string" 
            },
            "selectionPattern": "string",
            "statusCode": "string"
         }
      },
      "integrationTarget": "string",
      "passthroughBehavior": "string",
      "requestParameters": { 
         "string" : "string" 
      },
      "requestTemplates": { 
         "string" : "string" 
      },
      "responseTransferMode": "string",
      "timeoutInMillis": number,
      "tlsConfig": { 
         "insecureSkipVerification": boolean
      },
      "type": "string",
      "uri": "string"
   },
   "methodResponses": { 
      "string" : { 
         "responseModels": { 
            "string" : "string" 
         },
         "responseParameters": { 
            "string" : boolean 
         },
         "statusCode": "string"
      }
   },
   "operationName": "string",
   "requestModels": { 
      "string" : "string" 
   },
   "requestParameters": { 
      "string" : boolean 
   },
   "requestValidatorId": "string"
}
```

## Response Elements
<a name="API_GetMethod_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [apiKeyRequired](#API_GetMethod_ResponseSyntax) **   <a name="apigw-GetMethod-response-apiKeyRequired"></a>
A boolean flag specifying whether a valid ApiKey is required to invoke this method.  
Type: Boolean

 ** [authorizationScopes](#API_GetMethod_ResponseSyntax) **   <a name="apigw-GetMethod-response-authorizationScopes"></a>
A list of authorization scopes configured on the method. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.  
Type: Array of strings

 ** [authorizationType](#API_GetMethod_ResponseSyntax) **   <a name="apigw-GetMethod-response-authorizationType"></a>
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.  
Type: String

 ** [authorizerId](#API_GetMethod_ResponseSyntax) **   <a name="apigw-GetMethod-response-authorizerId"></a>
The identifier of an authorizer to use on this method. The method's authorization type must be `CUSTOM` or `COGNITO_USER_POOLS`.  
Type: String

 ** [httpMethod](#API_GetMethod_ResponseSyntax) **   <a name="apigw-GetMethod-response-httpMethod"></a>
The method's HTTP verb.  
Type: String

 ** [methodIntegration](#API_GetMethod_ResponseSyntax) **   <a name="apigw-GetMethod-response-methodIntegration"></a>
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.  
Type: [Integration](API_Integration.md) object

 ** [methodResponses](#API_GetMethod_ResponseSyntax) **   <a name="apigw-GetMethod-response-methodResponses"></a>
Gets a method response associated with a given HTTP status code.   
Type: String to [MethodResponse](API_MethodResponse.md) object map

 ** [operationName](#API_GetMethod_ResponseSyntax) **   <a name="apigw-GetMethod-response-operationName"></a>
A human-friendly operation identifier for the method. For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example.  
Type: String

 ** [requestModels](#API_GetMethod_ResponseSyntax) **   <a name="apigw-GetMethod-response-requestModels"></a>
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).  
Type: String to string map

 ** [requestParameters](#API_GetMethod_ResponseSyntax) **   <a name="apigw-GetMethod-response-requestParameters"></a>
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.  
Type: String to boolean map

 ** [requestValidatorId](#API_GetMethod_ResponseSyntax) **   <a name="apigw-GetMethod-response-requestValidatorId"></a>
The identifier of a RequestValidator for request validation.  
Type: String

## Errors
<a name="API_GetMethod_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetMethod_Examples"></a>

### View the detailed information about the GET method on an API resource
<a name="API_GetMethod_Example_1"></a>

This example illustrates one usage of GetMethod.

#### Sample Request
<a name="API_GetMethod_Example_1_Request"></a>

```
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117
X-Amz-Date: 20160613T205752Z
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}
```

#### Sample Response
<a name="API_GetMethod_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
        "name": "integration",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
        "name": "integrationresponse",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
        "name": "method",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
        "name": "methodresponse",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET",
      "name": "GET",
      "title": "GET"
    },
    "integration:put": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration"
    },
    "method:delete": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET"
    },
    "method:integration": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration"
    },
    "method:responses": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200",
      "name": "200",
      "title": "200"
    },
    "method:update": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET"
    },
    "methodresponse:put": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/{status_code}",
      "templated": true
    }
  },
  "apiKeyRequired": false,
  "authorizationType": "NONE",
  "httpMethod": "GET",
  "requestParameters": {
    "method.request.querystring.operand2": false,
    "method.request.querystring.operator": false,
    "method.request.querystring.operand1": false
  },
  "_embedded": {
    "method:integration": {
      "_links": {
        "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"
        }
      }
    },
    "method:responses": {
      "_links": {
        "self": {
          "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200",
          "name": "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"
    }
  }
}
```

## See Also
<a name="API_GetMethod_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetMethod) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetMethod) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetMethod) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetMethod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetMethod) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetMethod) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetMethod) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetMethod) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetMethod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetMethod) 

# GetMethodResponse
<a name="API_GetMethodResponse"></a>

Describes a MethodResponse resource.

## Request Syntax
<a name="API_GetMethodResponse_RequestSyntax"></a>

```
GET /restapis/restapi_id/resources/resource_id/methods/http_method/responses/status_code HTTP/1.1
```

## URI Request Parameters
<a name="API_GetMethodResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_GetMethodResponse_RequestSyntax) **   <a name="apigw-GetMethodResponse-request-uri-httpMethod"></a>
The HTTP verb of the Method resource.  
Required: Yes

 ** [resource\$1id](#API_GetMethodResponse_RequestSyntax) **   <a name="apigw-GetMethodResponse-request-uri-resourceId"></a>
The Resource identifier for the MethodResponse resource.  
Required: Yes

 ** [restapi\$1id](#API_GetMethodResponse_RequestSyntax) **   <a name="apigw-GetMethodResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [status\$1code](#API_GetMethodResponse_RequestSyntax) **   <a name="apigw-GetMethodResponse-request-uri-statusCode"></a>
The status code for the MethodResponse resource.  
Pattern: `[1-5]\d\d`   
Required: Yes

## Request Body
<a name="API_GetMethodResponse_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetMethodResponse_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "responseModels": { 
      "string" : "string" 
   },
   "responseParameters": { 
      "string" : boolean 
   },
   "statusCode": "string"
}
```

## Response Elements
<a name="API_GetMethodResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [responseModels](#API_GetMethodResponse_ResponseSyntax) **   <a name="apigw-GetMethodResponse-response-responseModels"></a>
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.  
Type: String to string map

 ** [responseParameters](#API_GetMethodResponse_ResponseSyntax) **   <a name="apigw-GetMethodResponse-response-responseParameters"></a>
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.)  
Type: String to boolean map

 ** [statusCode](#API_GetMethodResponse_ResponseSyntax) **   <a name="apigw-GetMethodResponse-response-statusCode"></a>
The method response's status code.  
Type: String  
Pattern: `[1-5]\d\d` 

## Errors
<a name="API_GetMethodResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetMethodResponse_Examples"></a>

### Get a 200 OK response of a GET method
<a name="API_GetMethodResponse_Example_1"></a>

This example illustrates one usage of GetMethodResponse.

#### Sample Request
<a name="API_GetMethodResponse_Example_1_Request"></a>

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

#### Sample Response
<a name="API_GetMethodResponse_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
      "name": "methodresponse",
      "templated": true
    },
    "self": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200",
      "title": "200"
    },
    "methodresponse:delete": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200"
    },
    "methodresponse:update": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200"
    }
  },
  "responseModels": {
    "application/json": "Empty"
  },
  "responseParameters": {
    "method.response.header.operator": false,
    "method.response.header.operand_2": false,
    "method.response.header.operand_1": false
  },
  "statusCode": "200"
}
```

## See Also
<a name="API_GetMethodResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetMethodResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetMethodResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetMethodResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetMethodResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetMethodResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetMethodResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetMethodResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetMethodResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetMethodResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetMethodResponse) 

# GetModel
<a name="API_GetModel"></a>

Describes an existing model defined for a RestApi resource.

## Request Syntax
<a name="API_GetModel_RequestSyntax"></a>

```
GET /restapis/restapi_id/models/model_name?flatten=flatten HTTP/1.1
```

## URI Request Parameters
<a name="API_GetModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flatten](#API_GetModel_RequestSyntax) **   <a name="apigw-GetModel-request-uri-flatten"></a>
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`.

 ** [model\$1name](#API_GetModel_RequestSyntax) **   <a name="apigw-GetModel-request-uri-modelName"></a>
The name of the model as an identifier.  
Required: Yes

 ** [restapi\$1id](#API_GetModel_RequestSyntax) **   <a name="apigw-GetModel-request-uri-restApiId"></a>
The RestApi identifier under which the Model exists.  
Required: Yes

## Request Body
<a name="API_GetModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetModel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contentType": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "schema": "string"
}
```

## Response Elements
<a name="API_GetModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contentType](#API_GetModel_ResponseSyntax) **   <a name="apigw-GetModel-response-contentType"></a>
The content-type for the model.  
Type: String

 ** [description](#API_GetModel_ResponseSyntax) **   <a name="apigw-GetModel-response-description"></a>
The description of the model.  
Type: String

 ** [id](#API_GetModel_ResponseSyntax) **   <a name="apigw-GetModel-response-id"></a>
The identifier for the model resource.  
Type: String

 ** [name](#API_GetModel_ResponseSyntax) **   <a name="apigw-GetModel-response-name"></a>
The name of the model. Must be an alphanumeric string.  
Type: String

 ** [schema](#API_GetModel_ResponseSyntax) **   <a name="apigw-GetModel-response-schema"></a>
The schema for the model. For `application/json` models, this should be JSON schema draft 4 model. Do not include "\$1\$1/" characters in the description of any properties because such "\$1\$1/" 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.  
Type: String

## Errors
<a name="API_GetModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetModel_Examples"></a>

### Retrieve a named Model resource representing an API data model
<a name="API_GetModel_Example_1"></a>

This example illustrates one usage of GetModel.

#### Sample Request
<a name="API_GetModel_Example_1_Request"></a>

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

#### Sample Response
<a name="API_GetModel_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-model-{rel}.html",
      "name": "model",
      "templated": true
    },
    "self": {
      "href": "/restapis/uojnr9hd57/models/output?flatten=false"
    },
    "model:create": {
      "href": "/restapis/uojnr9hd57/models"
    },
    "model:delete": {
      "href": "/restapis/uojnr9hd57/models/output"
    },
    "model:generate-template": {
      "href": "/restapis/uojnr9hd57/models/output/default_template"
    },
    "model:update": {
      "href": "/restapis/uojnr9hd57/models/output"
    }
  },
  "contentType": "application/json",
  "id": "hkhn0z",
  "name": "output",
  "schema": "{\n\t\"title\": \"Calc output\",\n\t\"type\": \"object\",\n\t\"properties\": {\n\t\t\"a\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"b\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"op\": {\n\t\t\t\"description\": \"operations of +-*/\",\n\t\t\t\"type\": \"string\"\n\t\t},\n\t\t\"c\": {\n\t\t    \"type\": \"number\"\n\t\t}\n\t},\n\t\"required\": [\"a\", \"b\", \"op\"]\n}\n"
}
```

## See Also
<a name="API_GetModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetModel) 

# GetModels
<a name="API_GetModels"></a>

Describes existing Models defined for a RestApi resource.

## Request Syntax
<a name="API_GetModels_RequestSyntax"></a>

```
GET /restapis/restapi_id/models?limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetModels_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetModels_RequestSyntax) **   <a name="apigw-GetModels-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetModels_RequestSyntax) **   <a name="apigw-GetModels-request-uri-position"></a>
The current pagination position in the paged result set.

 ** [restapi\$1id](#API_GetModels_RequestSyntax) **   <a name="apigw-GetModels-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetModels_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetModels_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "contentType": "string",
         "description": "string",
         "id": "string",
         "name": "string",
         "schema": "string"
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetModels_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetModels_ResponseSyntax) **   <a name="apigw-GetModels-response-item"></a>
The current page of elements from this collection.  
Type: Array of [Model](API_Model.md) objects

 ** [position](#API_GetModels_ResponseSyntax) **   <a name="apigw-GetModels-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetModels_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetModels_Examples"></a>

### Get the collection of models defined for an API
<a name="API_GetModels_Example_1"></a>

This example illustrates one usage of GetModels.

#### Sample Request
<a name="API_GetModels_Example_1_Request"></a>

```
GET /restapis/l9kujxkzq2/models HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
Content-Length: 60
X-Amz-Date: 20170223T172652Z
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}
```

#### Sample Response
<a name="API_GetModels_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-model-{rel}.html",
      "name": "model",
      "templated": true
    },
    "self": {
      "href": "/restapis/l9kujxkzq2/models"
    },
    "item": [
      {
        "href": "/restapis/l9kujxkzq2/models/Empty?flatten=false"
      },
      {
        "href": "/restapis/l9kujxkzq2/models/Error?flatten=false"
      }
    ],
    "model:by-name": {
      "href": "/restapis/l9kujxkzq2/models/{model_name}?flatten=false",
      "templated": true
    }
  },
  "_embedded": {
    "item": [
      {
        "_links": {
          "self": {
            "href": "/restapis/l9kujxkzq2/models/Empty?flatten=false"
          },
          "model:create": {
            "href": "/restapis/l9kujxkzq2/models"
          },
          "model:delete": {
            "href": "/restapis/l9kujxkzq2/models/Empty"
          },
          "model:generate-template": {
            "href": "/restapis/l9kujxkzq2/models/Empty/default_template"
          },
          "model:update": {
            "href": "/restapis/l9kujxkzq2/models/Empty"
          }
        },
        "contentType": "application/json",
        "description": "This is a default empty schema model",
        "id": "71l0yh",
        "name": "Empty",
        "schema": "{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"title\" : \"Empty Schema\",\n  \"type\" : \"object\"\n}"
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/l9kujxkzq2/models/Error?flatten=false"
          },
          "model:create": {
            "href": "/restapis/l9kujxkzq2/models"
          },
          "model:delete": {
            "href": "/restapis/l9kujxkzq2/models/Error"
          },
          "model:generate-template": {
            "href": "/restapis/l9kujxkzq2/models/Error/default_template"
          },
          "model:update": {
            "href": "/restapis/l9kujxkzq2/models/Error"
          }
        },
        "contentType": "application/json",
        "description": "This is a default error schema model",
        "id": "sddpxt",
        "name": "Error",
        "schema": "{\n  \"$schema\" : \"http://json-schema.org/draft-04/schema#\",\n  \"title\" : \"Error Schema\",\n  \"type\" : \"object\",\n  \"properties\" : {\n    \"message\" : { \"type\" : \"string\" }\n  }\n}"
      }
    ]
  }
}
```

## See Also
<a name="API_GetModels_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetModels) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetModels) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetModels) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetModels) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetModels) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetModels) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetModels) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetModels) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetModels) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetModels) 

# GetModelTemplate
<a name="API_GetModelTemplate"></a>

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

## Request Syntax
<a name="API_GetModelTemplate_RequestSyntax"></a>

```
GET /restapis/restapi_id/models/model_name/default_template HTTP/1.1
```

## URI Request Parameters
<a name="API_GetModelTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [model\$1name](#API_GetModelTemplate_RequestSyntax) **   <a name="apigw-GetModelTemplate-request-uri-modelName"></a>
The name of the model for which to generate a template.  
Required: Yes

 ** [restapi\$1id](#API_GetModelTemplate_RequestSyntax) **   <a name="apigw-GetModelTemplate-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetModelTemplate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetModelTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "value": "string"
}
```

## Response Elements
<a name="API_GetModelTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [value](#API_GetModelTemplate_ResponseSyntax) **   <a name="apigw-GetModelTemplate-response-value"></a>
The Apache Velocity Template Language (VTL) template content used for the template resource.  
Type: String

## Errors
<a name="API_GetModelTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetModelTemplate_Examples"></a>

### Generate the sample template from a model
<a name="API_GetModelTemplate_Example_1"></a>

This example illustrates one usage of GetModelTemplate.

#### Sample Request
<a name="API_GetModelTemplate_Example_1_Request"></a>

```
GET /restapis/uojnr9hd57/models/output/default_template HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160614T202448Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160614/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
```

#### Sample Response
<a name="API_GetModelTemplate_Example_1_Response"></a>

```
{
  "_links": {
    "self": {
      "href": "/restapis/uojnr9hd57/models/output/default_template"
    }
  },
  "value": "#set($inputRoot = $input.path('$'))\n{\n  \"a\" : 3.1415,\n  \"b\" : 3.1415,\n  \"op\" : \"foo\",\n  \"c\" : 3.1415\n}"
}
```

## See Also
<a name="API_GetModelTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetModelTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetModelTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetModelTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetModelTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetModelTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetModelTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetModelTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetModelTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetModelTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetModelTemplate) 

# GetRequestValidator
<a name="API_GetRequestValidator"></a>

Gets a RequestValidator of a given RestApi.

## Request Syntax
<a name="API_GetRequestValidator_RequestSyntax"></a>

```
GET /restapis/restapi_id/requestvalidators/requestvalidator_id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetRequestValidator_RequestParameters"></a>

The request uses the following URI parameters.

 ** [requestvalidator\$1id](#API_GetRequestValidator_RequestSyntax) **   <a name="apigw-GetRequestValidator-request-uri-requestValidatorId"></a>
The identifier of the RequestValidator to be retrieved.  
Required: Yes

 ** [restapi\$1id](#API_GetRequestValidator_RequestSyntax) **   <a name="apigw-GetRequestValidator-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetRequestValidator_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetRequestValidator_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "id": "string",
   "name": "string",
   "validateRequestBody": boolean,
   "validateRequestParameters": boolean
}
```

## Response Elements
<a name="API_GetRequestValidator_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [id](#API_GetRequestValidator_ResponseSyntax) **   <a name="apigw-GetRequestValidator-response-id"></a>
The identifier of this RequestValidator.  
Type: String

 ** [name](#API_GetRequestValidator_ResponseSyntax) **   <a name="apigw-GetRequestValidator-response-name"></a>
The name of this RequestValidator  
Type: String

 ** [validateRequestBody](#API_GetRequestValidator_ResponseSyntax) **   <a name="apigw-GetRequestValidator-response-validateRequestBody"></a>
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.  
Type: Boolean

 ** [validateRequestParameters](#API_GetRequestValidator_ResponseSyntax) **   <a name="apigw-GetRequestValidator-response-validateRequestParameters"></a>
A Boolean flag to indicate whether to validate request parameters (`true`) or not (`false`).  
Type: Boolean

## Errors
<a name="API_GetRequestValidator_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetRequestValidator_Examples"></a>

### Get the specified RequestValidator of an API
<a name="API_GetRequestValidator_Example_1"></a>

This example illustrates one usage of GetRequestValidator.

#### Sample Request
<a name="API_GetRequestValidator_Example_1_Request"></a>

```
GET /restapis/mkhqppt4e4/requestvalidators/1t3hul HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T172652Z
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}
```

#### Sample Response
<a name="API_GetRequestValidator_Example_1_Response"></a>

```
{
  "_links": {
    "self": {
      "href": "/restapis/mkhqppt4e4/requestvalidators/1t3hul"
    },
    "request-validator-delete": {
      "href": "/restapis/mkhqppt4e4/requestvalidators/1t3hul"
    },
    "request-validator-update": {
      "href": "/restapis/mkhqppt4e4/requestvalidators/1t3hul"
    }
  },
  "id": "1t3hul",
  "name": "params-only",
  "validateRequestBody": false,
  "validateRequestParameters": true
}
```

## See Also
<a name="API_GetRequestValidator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetRequestValidator) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetRequestValidator) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetRequestValidator) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetRequestValidator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetRequestValidator) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetRequestValidator) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetRequestValidator) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetRequestValidator) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetRequestValidator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetRequestValidator) 

# GetRequestValidators
<a name="API_GetRequestValidators"></a>

Gets the RequestValidators collection of a given RestApi.

## Request Syntax
<a name="API_GetRequestValidators_RequestSyntax"></a>

```
GET /restapis/restapi_id/requestvalidators?limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetRequestValidators_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetRequestValidators_RequestSyntax) **   <a name="apigw-GetRequestValidators-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetRequestValidators_RequestSyntax) **   <a name="apigw-GetRequestValidators-request-uri-position"></a>
The current pagination position in the paged result set.

 ** [restapi\$1id](#API_GetRequestValidators_RequestSyntax) **   <a name="apigw-GetRequestValidators-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetRequestValidators_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetRequestValidators_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "id": "string",
         "name": "string",
         "validateRequestBody": boolean,
         "validateRequestParameters": boolean
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetRequestValidators_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetRequestValidators_ResponseSyntax) **   <a name="apigw-GetRequestValidators-response-item"></a>
The current page of elements from this collection.  
Type: Array of [RequestValidator](API_RequestValidator.md) objects

 ** [position](#API_GetRequestValidators_ResponseSyntax) **   <a name="apigw-GetRequestValidators-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetRequestValidators_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetRequestValidators_Examples"></a>

### Get the RequestValidators collection of an API
<a name="API_GetRequestValidators_Example_1"></a>

This example illustrates one usage of GetRequestValidators.

#### Sample Request
<a name="API_GetRequestValidators_Example_1_Request"></a>

```
GET /restapis/mkhqppt4e4/requestvalidators HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T172652Z
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}
```

#### Sample Response
<a name="API_GetRequestValidators_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-requestvalidator-{rel}.html",
      "name": "requestvalidator",
      "templated": true
    },
    "self": {
      "href": "/restapis/mkhqppt4e4/requestvalidators"
    },
    "item": [
      {
        "href": "/restapis/mkhqppt4e4/requestvalidators/1t3hul"
      },
      {
        "href": "/restapis/mkhqppt4e4/requestvalidators/8sbwvf"
      }
    ],
    "requestvalidator:by-id": {
      "href": "/restapis/mkhqppt4e4/requestvalidators/{requestvalidator_id}",
      "templated": true
    },
    "requestvalidator:create": {
      "href": "/restapis/mkhqppt4e4/requestvalidators"
    }
  },
  "_embedded": {
    "item": [
      {
        "_links": {
          "self": {
            "href": "/restapis/mkhqppt4e4/requestvalidators/1t3hul"
          },
          "request-validator-delete": {
            "href": "/restapis/mkhqppt4e4/requestvalidators/1t3hul"
          },
          "request-validator-update": {
            "href": "/restapis/mkhqppt4e4/requestvalidators/1t3hul"
          }
        },
        "id": "1t3hul",
        "name": "params-only",
        "validateRequestBody": false,
        "validateRequestParameters": true
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/mkhqppt4e4/requestvalidators/8sbwvf"
          },
          "request-validator-delete": {
            "href": "/restapis/mkhqppt4e4/requestvalidators/8sbwvf"
          },
          "request-validator-update": {
            "href": "/restapis/mkhqppt4e4/requestvalidators/8sbwvf"
          }
        },
        "id": "8sbwvf",
        "name": "all",
        "validateRequestBody": true,
        "validateRequestParameters": true
      }
    ]
  }
}
```

## See Also
<a name="API_GetRequestValidators_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetRequestValidators) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetRequestValidators) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetRequestValidators) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetRequestValidators) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetRequestValidators) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetRequestValidators) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetRequestValidators) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetRequestValidators) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetRequestValidators) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetRequestValidators) 

# GetResource
<a name="API_GetResource"></a>

Lists information about a resource.

## Request Syntax
<a name="API_GetResource_RequestSyntax"></a>

```
GET /restapis/restapi_id/resources/resource_id?embed=embed HTTP/1.1
```

## URI Request Parameters
<a name="API_GetResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [embed](#API_GetResource_RequestSyntax) **   <a name="apigw-GetResource-request-uri-embed"></a>
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`.

 ** [resource\$1id](#API_GetResource_RequestSyntax) **   <a name="apigw-GetResource-request-uri-resourceId"></a>
The identifier for the Resource resource.  
Required: Yes

 ** [restapi\$1id](#API_GetResource_RequestSyntax) **   <a name="apigw-GetResource-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "id": "string",
   "parentId": "string",
   "path": "string",
   "pathPart": "string",
   "resourceMethods": { 
      "string" : { 
         "apiKeyRequired": boolean,
         "authorizationScopes": [ "string" ],
         "authorizationType": "string",
         "authorizerId": "string",
         "httpMethod": "string",
         "methodIntegration": { 
            "cacheKeyParameters": [ "string" ],
            "cacheNamespace": "string",
            "connectionId": "string",
            "connectionType": "string",
            "contentHandling": "string",
            "credentials": "string",
            "httpMethod": "string",
            "integrationResponses": { 
               "string" : { 
                  "contentHandling": "string",
                  "responseParameters": { 
                     "string" : "string" 
                  },
                  "responseTemplates": { 
                     "string" : "string" 
                  },
                  "selectionPattern": "string",
                  "statusCode": "string"
               }
            },
            "integrationTarget": "string",
            "passthroughBehavior": "string",
            "requestParameters": { 
               "string" : "string" 
            },
            "requestTemplates": { 
               "string" : "string" 
            },
            "responseTransferMode": "string",
            "timeoutInMillis": number,
            "tlsConfig": { 
               "insecureSkipVerification": boolean
            },
            "type": "string",
            "uri": "string"
         },
         "methodResponses": { 
            "string" : { 
               "responseModels": { 
                  "string" : "string" 
               },
               "responseParameters": { 
                  "string" : boolean 
               },
               "statusCode": "string"
            }
         },
         "operationName": "string",
         "requestModels": { 
            "string" : "string" 
         },
         "requestParameters": { 
            "string" : boolean 
         },
         "requestValidatorId": "string"
      }
   }
}
```

## Response Elements
<a name="API_GetResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [id](#API_GetResource_ResponseSyntax) **   <a name="apigw-GetResource-response-id"></a>
The resource's identifier.  
Type: String

 ** [parentId](#API_GetResource_ResponseSyntax) **   <a name="apigw-GetResource-response-parentId"></a>
The parent resource's identifier.  
Type: String

 ** [path](#API_GetResource_ResponseSyntax) **   <a name="apigw-GetResource-response-path"></a>
The full path for this resource.  
Type: String

 ** [pathPart](#API_GetResource_ResponseSyntax) **   <a name="apigw-GetResource-response-pathPart"></a>
The last path segment for this resource.  
Type: String

 ** [resourceMethods](#API_GetResource_ResponseSyntax) **   <a name="apigw-GetResource-response-resourceMethods"></a>
Gets an API resource's method of a given HTTP verb.  
Type: String to [Method](API_Method.md) object map

## Errors
<a name="API_GetResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetResource_Examples"></a>

### Get an API resource of a given resource identifier
<a name="API_GetResource_Example_1"></a>

This example illustrates one usage of GetResource.

#### Sample Request
<a name="API_GetResource_Example_1_Request"></a>

```
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T025309Z
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}
```

#### Sample Response
<a name="API_GetResource_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
        "name": "method",c
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-resource-{rel}.html",
        "name": "resource",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2"
    },
    "method:by-http-method": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/{http_method}",
      "templated": true
    },
    "method:put": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/{http_method}",
      "templated": true
    },
    "resource:create-child": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2"
    },
    "resource:methods": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET",
      "name": "GET",
      "title": "GET"
    },
    "resource:update": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2"
    }
  },
  "id": "3kzxbg5sa2",
  "path": "/"
}
```

## See Also
<a name="API_GetResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetResource) 

# GetResources
<a name="API_GetResources"></a>

Lists information about a collection of Resource resources.

## Request Syntax
<a name="API_GetResources_RequestSyntax"></a>

```
GET /restapis/restapi_id/resources?embed=embed&limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetResources_RequestParameters"></a>

The request uses the following URI parameters.

 ** [embed](#API_GetResources_RequestSyntax) **   <a name="apigw-GetResources-request-uri-embed"></a>
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`.

 ** [limit](#API_GetResources_RequestSyntax) **   <a name="apigw-GetResources-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetResources_RequestSyntax) **   <a name="apigw-GetResources-request-uri-position"></a>
The current pagination position in the paged result set.

 ** [restapi\$1id](#API_GetResources_RequestSyntax) **   <a name="apigw-GetResources-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetResources_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetResources_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "id": "string",
         "parentId": "string",
         "path": "string",
         "pathPart": "string",
         "resourceMethods": { 
            "string" : { 
               "apiKeyRequired": boolean,
               "authorizationScopes": [ "string" ],
               "authorizationType": "string",
               "authorizerId": "string",
               "httpMethod": "string",
               "methodIntegration": { 
                  "cacheKeyParameters": [ "string" ],
                  "cacheNamespace": "string",
                  "connectionId": "string",
                  "connectionType": "string",
                  "contentHandling": "string",
                  "credentials": "string",
                  "httpMethod": "string",
                  "integrationResponses": { 
                     "string" : { 
                        "contentHandling": "string",
                        "responseParameters": { 
                           "string" : "string" 
                        },
                        "responseTemplates": { 
                           "string" : "string" 
                        },
                        "selectionPattern": "string",
                        "statusCode": "string"
                     }
                  },
                  "integrationTarget": "string",
                  "passthroughBehavior": "string",
                  "requestParameters": { 
                     "string" : "string" 
                  },
                  "requestTemplates": { 
                     "string" : "string" 
                  },
                  "responseTransferMode": "string",
                  "timeoutInMillis": number,
                  "tlsConfig": { 
                     "insecureSkipVerification": boolean
                  },
                  "type": "string",
                  "uri": "string"
               },
               "methodResponses": { 
                  "string" : { 
                     "responseModels": { 
                        "string" : "string" 
                     },
                     "responseParameters": { 
                        "string" : boolean 
                     },
                     "statusCode": "string"
                  }
               },
               "operationName": "string",
               "requestModels": { 
                  "string" : "string" 
               },
               "requestParameters": { 
                  "string" : boolean 
               },
               "requestValidatorId": "string"
            }
         }
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetResources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetResources_ResponseSyntax) **   <a name="apigw-GetResources-response-item"></a>
The current page of elements from this collection.  
Type: Array of [Resource](API_Resource.md) objects

 ** [position](#API_GetResources_ResponseSyntax) **   <a name="apigw-GetResources-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetResources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetResources_Examples"></a>

### Get an API resource collection
<a name="API_GetResources_Example_1"></a>

This example illustrates one usage of GetResources.

#### Sample Request
<a name="API_GetResources_Example_1_Request"></a>

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

#### Sample Response
<a name="API_GetResources_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
        "name": "method",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-resource-{rel}.html",
        "name": "resource",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis/fugvjdxtri/resources"
    },
    "item": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2"
    },
    "resource:by-id": {
      "href": "/restapis/fugvjdxtri/resources/{resource_id}{?embed}",
      "templated": true
    },
    "resource:create": {
      "href": "/restapis/fugvjdxtri/resources/{parent_id}",
      "templated": true
    }
  },
  "_embedded": {
    "item": {
      "_links": {
        "self": {
          "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2"
        },
        "method:by-http-method": {
          "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/{http_method}",
          "templated": true
        },
        "method:put": {
          "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/{http_method}",
          "templated": true
        },
        "resource:create-child": {
          "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2"
        },
        "resource:update": {
          "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2"
        }
      },
      "id": "3kzxbg5sa2",
      "path": "/"
    }
  }
}
```

## See Also
<a name="API_GetResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetResources) 

# GetRestApi
<a name="API_GetRestApi"></a>

Lists the RestApi resource in the collection.

## Request Syntax
<a name="API_GetRestApi_RequestSyntax"></a>

```
GET /restapis/restapi_id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetRestApi_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_GetRestApi_RequestSyntax) **   <a name="apigw-GetRestApi-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetRestApi_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetRestApi_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "apiKeySource": "string",
   "apiStatus": "string",
   "apiStatusMessage": "string",
   "binaryMediaTypes": [ "string" ],
   "createdDate": number,
   "description": "string",
   "disableExecuteApiEndpoint": boolean,
   "endpointAccessMode": "string",
   "endpointConfiguration": { 
      "ipAddressType": "string",
      "types": [ "string" ],
      "vpcEndpointIds": [ "string" ]
   },
   "id": "string",
   "minimumCompressionSize": number,
   "name": "string",
   "policy": "string",
   "rootResourceId": "string",
   "securityPolicy": "string",
   "tags": { 
      "string" : "string" 
   },
   "version": "string",
   "warnings": [ "string" ]
}
```

## Response Elements
<a name="API_GetRestApi_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [apiKeySource](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-apiKeySource"></a>
The source of the API key for metering requests according to a usage plan. Valid values are: >`HEADER` to read the API key from the `X-API-Key` header of a request. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer.  
Type: String  
Valid Values: `HEADER | AUTHORIZER` 

 ** [apiStatus](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-apiStatus"></a>
The ApiStatus of the RestApi.   
Type: String  
Valid Values: `UPDATING | AVAILABLE | PENDING | FAILED` 

 ** [apiStatusMessage](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-apiStatusMessage"></a>
 The status message of the RestApi. When the status message is `UPDATING` you can still invoke it.   
Type: String

 ** [binaryMediaTypes](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-binaryMediaTypes"></a>
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.  
Type: Array of strings

 ** [createdDate](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-createdDate"></a>
The timestamp when the API was created.  
Type: Timestamp

 ** [description](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-description"></a>
The API's description.  
Type: String

 ** [disableExecuteApiEndpoint](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-disableExecuteApiEndpoint"></a>
Specifies whether clients can invoke your API by using the default `execute-api` endpoint. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.  
Type: Boolean

 ** [endpointAccessMode](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-endpointAccessMode"></a>
 The endpoint access mode of the RestApi.   
Type: String  
Valid Values: `BASIC | STRICT` 

 ** [endpointConfiguration](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-endpointConfiguration"></a>
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.   
Type: [EndpointConfiguration](API_EndpointConfiguration.md) object

 ** [id](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-id"></a>
The API's identifier. This identifier is unique across all of your APIs in API Gateway.  
Type: String

 ** [minimumCompressionSize](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-minimumCompressionSize"></a>
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.  
Type: Integer

 ** [name](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-name"></a>
The API's name.  
Type: String

 ** [policy](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-policy"></a>
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.  
Type: String

 ** [rootResourceId](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-rootResourceId"></a>
The API's root resource ID.  
Type: String

 ** [securityPolicy](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-securityPolicy"></a>
 The Transport Layer Security (TLS) version \$1 cipher suite for this RestApi.   
Type: String  
Valid Values: `TLS_1_0 | TLS_1_2 | SecurityPolicy_TLS13_1_3_2025_09 | SecurityPolicy_TLS13_1_3_FIPS_2025_09 | SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_PQ_2025_09 | SecurityPolicy_TLS13_1_2_2021_06 | SecurityPolicy_TLS13_2025_EDGE | SecurityPolicy_TLS12_PFS_2025_EDGE | SecurityPolicy_TLS12_2018_EDGE` 

 ** [tags](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [version](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-version"></a>
A version identifier for the API.  
Type: String

 ** [warnings](#API_GetRestApi_ResponseSyntax) **   <a name="apigw-GetRestApi-response-warnings"></a>
The warning messages reported when `failonwarnings` is turned on during API import.  
Type: Array of strings

## Errors
<a name="API_GetRestApi_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetRestApi_Examples"></a>

### Retrieve information about a REST API
<a name="API_GetRestApi_Example_1"></a>

This example illustrates one usage of GetRestApi.

#### Sample Request
<a name="API_GetRestApi_Example_1_Request"></a>

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

#### Sample Response
<a name="API_GetRestApi_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-authorizer-{rel}.html",
        "name": "authorizer",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-deployment-{rel}.html",
        "name": "deployment",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-model-{rel}.html",
        "name": "model",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-resource-{rel}.html",
        "name": "resource",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-restapi-{rel}.html",
        "name": "restapi",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-stage-{rel}.html",
        "name": "stage",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis/0n1anifwvf"
    },
    "authorizer:by-id": {
      "href": "/restapis/0n1anifwvf/authorizers/{authorizer_id}",
      "templated": true
    },
    "authorizer:create": {
      "href": "/restapis/0n1anifwvf/authorizers"
    },
    "deployment:by-id": {
      "href": "/restapis/0n1anifwvf/deployments/{deployment_id}{?embed}",
      "templated": true
    },
    "deployment:create": {
      "href": "/restapis/0n1anifwvf/deployments"
    },
    "model:by-name": {
      "href": "/restapis/0n1anifwvf/models/{model_name}?flatten=false",
      "templated": true
    },
    "model:create": {
      "href": "/restapis/0n1anifwvf/models"
    },
    "resource:by-id": {
      "href": "/restapis/0n1anifwvf/resources/{resource_id}{?embed}",
      "templated": true
    },
    "resource:create": {
      "href": "/restapis/0n1anifwvf/resources/ny9qrywoj2"
    },
    "restapi:authorizers": {
      "href": "/restapis/0n1anifwvf/authorizers"
    },
    "restapi:delete": {
      "href": "/restapis/0n1anifwvf"
    },
    "restapi:deployments": {
      "href": "/restapis/0n1anifwvf/deployments{?limit}",
      "templated": true
    },
    "restapi:models": {
      "href": "/restapis/0n1anifwvf/models"
    },
    "restapi:resources": {
      "href": "/restapis/0n1anifwvf/resources{?limit,embed}",
      "templated": true
    },
    "restapi:stages": {
      "href": "/restapis/0n1anifwvf/stages{?deployment_id}",
      "templated": true
    },
    "restapi:update": {
      "href": "/restapis/0n1anifwvf"
    },
    "stage:by-name": {
      "href": "/restapis/0n1anifwvf/stages/{stage_name}",
      "templated": true
    },
    "stage:create": {
      "href": "/restapis/0n1anifwvf/stages"
    }
  },
  "createdDate": "2016-04-05T19:58:27Z",
  "description": "Your first API with Amazon API Gateway. This is a sample API that integrates via HTTP with our demo Pet Store endpoints",
  "id": "0n1anifwvf",
  "rootResourceId" : "1abcd23e4f",
  "name": "PetStore"
}
```

## See Also
<a name="API_GetRestApi_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetRestApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetRestApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetRestApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetRestApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetRestApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetRestApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetRestApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetRestApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetRestApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetRestApi) 

# GetRestApis
<a name="API_GetRestApis"></a>

Lists the RestApis resources for your collection.

## Request Syntax
<a name="API_GetRestApis_RequestSyntax"></a>

```
GET /restapis?limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetRestApis_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetRestApis_RequestSyntax) **   <a name="apigw-GetRestApis-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetRestApis_RequestSyntax) **   <a name="apigw-GetRestApis-request-uri-position"></a>
The current pagination position in the paged result set.

## Request Body
<a name="API_GetRestApis_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetRestApis_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "apiKeySource": "string",
         "apiStatus": "string",
         "apiStatusMessage": "string",
         "binaryMediaTypes": [ "string" ],
         "createdDate": number,
         "description": "string",
         "disableExecuteApiEndpoint": boolean,
         "endpointAccessMode": "string",
         "endpointConfiguration": { 
            "ipAddressType": "string",
            "types": [ "string" ],
            "vpcEndpointIds": [ "string" ]
         },
         "id": "string",
         "minimumCompressionSize": number,
         "name": "string",
         "policy": "string",
         "rootResourceId": "string",
         "securityPolicy": "string",
         "tags": { 
            "string" : "string" 
         },
         "version": "string",
         "warnings": [ "string" ]
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetRestApis_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetRestApis_ResponseSyntax) **   <a name="apigw-GetRestApis-response-item"></a>
The current page of elements from this collection.  
Type: Array of [RestApi](API_RestApi.md) objects

 ** [position](#API_GetRestApis_ResponseSyntax) **   <a name="apigw-GetRestApis-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetRestApis_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetRestApis_Examples"></a>

### Retrieve REST APIs
<a name="API_GetRestApis_Example_1"></a>

The following example GET request retrieves one API from an account. The `limit` query string parameter is used to limit the quantity of the returned result. For illustrative purposes, we choose `limit=1`.

 A successful response returns an API that can be navigated to by following the linked item or examining the embedded item resource.

#### Sample Request
<a name="API_GetRestApis_Example_1_Request"></a>

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

#### Sample Response
<a name="API_GetRestApis_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-authorizer-{rel}.html",
        "name": "authorizer",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-deployment-{rel}.html",
        "name": "deployment",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-model-{rel}.html",
        "name": "model",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-resource-{rel}.html",
        "name": "resource",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-restapi-{rel}.html",
        "name": "restapi",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-stage-{rel}.html",
        "name": "stage",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis?limit=1"
    },
    "item": {
      "href": "/restapis/0n1anifwvf"
    },
    "next": {
      "href": "/restapis?position=aWQ9UzBuMWFuaWZ3dmY%3D&limit=1"
    },
    "restapi:by-id": {
      "href": "/restapis/{restapi_id}",
      "templated": true
    },
    "restapi:create": {
      "href": "/restapis"
    },
    "restapi:put": {
      "href": "/restapis/{restapi_id}?failonwarnings=false{&mode}",
      "templated": true
    }
  },
  "_embedded": {
    "item": {
      "_links": {
        "self": {
          "href": "/restapis/0n1anifwvf"
        },
        "authorizer:by-id": {
          "href": "/restapis/0n1anifwvf/authorizers/{authorizer_id}",
          "templated": true
        },
        "authorizer:create": {
          "href": "/restapis/0n1anifwvf/authorizers"
        },
        "deployment:by-id": {
          "href": "/restapis/0n1anifwvf/deployments/{deployment_id}{?embed}",
          "templated": true
        },
        "deployment:create": {
          "href": "/restapis/0n1anifwvf/deployments"
        },
        "model:by-name": {
          "href": "/restapis/0n1anifwvf/models/{model_name}?flatten=false",
          "templated": true
        },
        "model:create": {
          "href": "/restapis/0n1anifwvf/models"
        },
        "resource:by-id": {
          "href": "/restapis/0n1anifwvf/resources/{resource_id}{?embed}",
          "templated": true
        },
        "resource:create": {
          "href": "/restapis/0n1anifwvf/resources/ny9qrywoj2"
        },
        "restapi:authorizers": {
          "href": "/restapis/0n1anifwvf/authorizers"
        },
        "restapi:delete": {
          "href": "/restapis/0n1anifwvf"
        },
        "restapi:deployments": {
          "href": "/restapis/0n1anifwvf/deployments{?limit}",
          "templated": true
        },
        "restapi:models": {
          "href": "/restapis/0n1anifwvf/models"
        },
        "restapi:resources": {
          "href": "/restapis/0n1anifwvf/resources{?limit,embed}",
          "templated": trueget
        },
        "restapi:stages": {
          "href": "/restapis/0n1anifwvf/stages{?deployment_id}",
          "templated": true
        },
        "restapi:update": {
          "href": "/restapis/0n1anifwvf"
        },
        "stage:by-name": {
          "href": "/restapis/0n1anifwvf/stages/{stage_name}",
          "templated": true
        },
        "stage:create": {
          "href": "/restapis/0n1anifwvf/stages"
        }
      },
      "createdDate": "2016-04-05T19:58:27Z",
      "description": "Your first API with Amazon API Gateway. This is a sample API that integrates via HTTP with our demo Pet Store endpoints",
      "id": "0n1anifwvf",
      "name": "PetStore"
    }
  }
}
```

## See Also
<a name="API_GetRestApis_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetRestApis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetRestApis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetRestApis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetRestApis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetRestApis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetRestApis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetRestApis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetRestApis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetRestApis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetRestApis) 

# GetSdk
<a name="API_GetSdk"></a>

Generates a client SDK for a RestApi and Stage.

## Request Syntax
<a name="API_GetSdk_RequestSyntax"></a>

```
GET /restapis/restapi_id/stages/stage_name/sdks/sdk_type?parameters HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSdk_RequestParameters"></a>

The request uses the following URI parameters.

 ** [parameters](#API_GetSdk_RequestSyntax) **   <a name="apigw-GetSdk-request-uri-parameters"></a>
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. 

 ** [restapi\$1id](#API_GetSdk_RequestSyntax) **   <a name="apigw-GetSdk-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [sdk\$1type](#API_GetSdk_RequestSyntax) **   <a name="apigw-GetSdk-request-uri-sdkType"></a>
The language for the generated SDK. Currently `java`, `javascript`, `android`, `objectivec` (for iOS), `swift` (for iOS), and `ruby` are supported.  
Required: Yes

 ** [stage\$1name](#API_GetSdk_RequestSyntax) **   <a name="apigw-GetSdk-request-uri-stageName"></a>
The name of the Stage that the SDK will use.  
Required: Yes

## Request Body
<a name="API_GetSdk_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSdk_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-Type: contentType
Content-Disposition: contentDisposition

body
```

## Response Elements
<a name="API_GetSdk_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

 ** [contentDisposition](#API_GetSdk_ResponseSyntax) **   <a name="apigw-GetSdk-response-contentDisposition"></a>
The content-disposition header value in the HTTP response.

 ** [contentType](#API_GetSdk_ResponseSyntax) **   <a name="apigw-GetSdk-response-contentType"></a>
The content-type header value in the HTTP response.

The response returns the following as the HTTP body.

 ** [body](#API_GetSdk_ResponseSyntax) **   <a name="apigw-GetSdk-response-body"></a>
The binary blob response to GetSdk, which contains the generated SDK.

## Errors
<a name="API_GetSdk_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetSdk_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetSdk) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetSdk) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetSdk) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetSdk) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetSdk) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetSdk) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetSdk) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetSdk) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetSdk) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetSdk) 

# GetSdkType
<a name="API_GetSdkType"></a>

Gets an SDK type.

## Request Syntax
<a name="API_GetSdkType_RequestSyntax"></a>

```
GET /sdktypes/sdktype_id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSdkType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sdktype\$1id](#API_GetSdkType_RequestSyntax) **   <a name="apigw-GetSdkType-request-uri-id"></a>
The identifier of the queried SdkType instance.  
Required: Yes

## Request Body
<a name="API_GetSdkType_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSdkType_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configurationProperties": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "friendlyName": "string",
         "name": "string",
         "required": boolean
      }
   ],
   "description": "string",
   "friendlyName": "string",
   "id": "string"
}
```

## Response Elements
<a name="API_GetSdkType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configurationProperties](#API_GetSdkType_ResponseSyntax) **   <a name="apigw-GetSdkType-response-configurationProperties"></a>
A list of configuration properties of an SdkType.  
Type: Array of [SdkConfigurationProperty](API_SdkConfigurationProperty.md) objects

 ** [description](#API_GetSdkType_ResponseSyntax) **   <a name="apigw-GetSdkType-response-description"></a>
The description of an SdkType.  
Type: String

 ** [friendlyName](#API_GetSdkType_ResponseSyntax) **   <a name="apigw-GetSdkType-response-friendlyName"></a>
The user-friendly name of an SdkType instance.  
Type: String

 ** [id](#API_GetSdkType_ResponseSyntax) **   <a name="apigw-GetSdkType-response-id"></a>
The identifier of an SdkType instance.  
Type: String

## Errors
<a name="API_GetSdkType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetSdkType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetSdkType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetSdkType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetSdkType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetSdkType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetSdkType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetSdkType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetSdkType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetSdkType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetSdkType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetSdkType) 

# GetSdkTypes
<a name="API_GetSdkTypes"></a>

Gets SDK types

## Request Syntax
<a name="API_GetSdkTypes_RequestSyntax"></a>

```
GET /sdktypes?limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSdkTypes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetSdkTypes_RequestSyntax) **   <a name="apigw-GetSdkTypes-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetSdkTypes_RequestSyntax) **   <a name="apigw-GetSdkTypes-request-uri-position"></a>
The current pagination position in the paged result set.

## Request Body
<a name="API_GetSdkTypes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSdkTypes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "configurationProperties": [ 
            { 
               "defaultValue": "string",
               "description": "string",
               "friendlyName": "string",
               "name": "string",
               "required": boolean
            }
         ],
         "description": "string",
         "friendlyName": "string",
         "id": "string"
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetSdkTypes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetSdkTypes_ResponseSyntax) **   <a name="apigw-GetSdkTypes-response-item"></a>
The current page of elements from this collection.  
Type: Array of [SdkType](API_SdkType.md) objects

 ** [position](#API_GetSdkTypes_ResponseSyntax) **   <a name="apigw-GetSdkTypes-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetSdkTypes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetSdkTypes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetSdkTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetSdkTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetSdkTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetSdkTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetSdkTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetSdkTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetSdkTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetSdkTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetSdkTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetSdkTypes) 

# GetStage
<a name="API_GetStage"></a>

Gets information about a Stage resource.

## Request Syntax
<a name="API_GetStage_RequestSyntax"></a>

```
GET /restapis/restapi_id/stages/stage_name HTTP/1.1
```

## URI Request Parameters
<a name="API_GetStage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_GetStage_RequestSyntax) **   <a name="apigw-GetStage-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [stage\$1name](#API_GetStage_RequestSyntax) **   <a name="apigw-GetStage-request-uri-stageName"></a>
The name of the Stage resource to get information about.  
Required: Yes

## Request Body
<a name="API_GetStage_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetStage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "accessLogSettings": { 
      "destinationArn": "string",
      "format": "string"
   },
   "cacheClusterEnabled": boolean,
   "cacheClusterSize": "string",
   "cacheClusterStatus": "string",
   "canarySettings": { 
      "deploymentId": "string",
      "percentTraffic": number,
      "stageVariableOverrides": { 
         "string" : "string" 
      },
      "useStageCache": boolean
   },
   "clientCertificateId": "string",
   "createdDate": number,
   "deploymentId": "string",
   "description": "string",
   "documentationVersion": "string",
   "lastUpdatedDate": number,
   "methodSettings": { 
      "string" : { 
         "cacheDataEncrypted": boolean,
         "cacheTtlInSeconds": number,
         "cachingEnabled": boolean,
         "dataTraceEnabled": boolean,
         "loggingLevel": "string",
         "metricsEnabled": boolean,
         "requireAuthorizationForCacheControl": boolean,
         "throttlingBurstLimit": number,
         "throttlingRateLimit": number,
         "unauthorizedCacheControlHeaderStrategy": "string"
      }
   },
   "stageName": "string",
   "tags": { 
      "string" : "string" 
   },
   "tracingEnabled": boolean,
   "variables": { 
      "string" : "string" 
   },
   "webAclArn": "string"
}
```

## Response Elements
<a name="API_GetStage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accessLogSettings](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-accessLogSettings"></a>
Settings for logging access in this stage.  
Type: [AccessLogSettings](API_AccessLogSettings.md) object

 ** [cacheClusterEnabled](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-cacheClusterEnabled"></a>
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set `CachingEnabled` to `true` for a method.   
Type: Boolean

 ** [cacheClusterSize](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-cacheClusterSize"></a>
The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).  
Type: String  
Valid Values: `0.5 | 1.6 | 6.1 | 13.5 | 28.4 | 58.2 | 118 | 237` 

 ** [cacheClusterStatus](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-cacheClusterStatus"></a>
The status of the cache cluster for the stage, if enabled.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | AVAILABLE | DELETE_IN_PROGRESS | NOT_AVAILABLE | FLUSH_IN_PROGRESS` 

 ** [canarySettings](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-canarySettings"></a>
Settings for the canary deployment in this stage.  
Type: [CanarySettings](API_CanarySettings.md) object

 ** [clientCertificateId](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-clientCertificateId"></a>
The identifier of a client certificate for an API stage.  
Type: String

 ** [createdDate](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-createdDate"></a>
The timestamp when the stage was created.  
Type: Timestamp

 ** [deploymentId](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-deploymentId"></a>
The identifier of the Deployment that the stage points to.  
Type: String

 ** [description](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-description"></a>
The stage's description.  
Type: String

 ** [documentationVersion](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-documentationVersion"></a>
The version of the associated API documentation.  
Type: String

 ** [lastUpdatedDate](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-lastUpdatedDate"></a>
The timestamp when the stage last updated.  
Type: Timestamp

 ** [methodSettings](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-methodSettings"></a>
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.   
Type: String to [MethodSetting](API_MethodSetting.md) object map

 ** [stageName](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-stageName"></a>
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.  
Type: String

 ** [tags](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [tracingEnabled](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-tracingEnabled"></a>
Specifies whether active tracing with X-ray is enabled for the Stage.  
Type: Boolean

 ** [variables](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-variables"></a>
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-._~:/?#&=,]+`.  
Type: String to string map

 ** [webAclArn](#API_GetStage_ResponseSyntax) **   <a name="apigw-GetStage-response-webAclArn"></a>
The ARN of the WebAcl associated with the Stage.  
Type: String

## Errors
<a name="API_GetStage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetStage_Examples"></a>

### Get a named stage of an API
<a name="API_GetStage_Example_1"></a>

This example illustrates one usage of GetStage.

#### Sample Request
<a name="API_GetStage_Example_1_Request"></a>

```
GET /restapis/uycll6xg9a/stages/prod HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T194603Z
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}
```

#### Sample Response
<a name="API_GetStage_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-stage-{rel}.html",
      "name": "stage",
      "templated": true
    },
    "self": {
      "href": "/restapis/uycll6xg9a/stages/prod"
    },
    "stage:delete": {
      "href": "/restapis/uycll6xg9a/stages/prod"
    },
    "stage:flush-authorizer-cache": {
      "href": "/restapis/uycll6xg9a/stages/prod/cache/authorizers"
    },
    "stage:update": {
      "href": "/restapis/uycll6xg9a/stages/prod"
    }
  },
  "cacheClusterEnabled": false,
  "cacheClusterStatus": "NOT_AVAILABLE",
  "createdDate": "2016-04-15T17:53:35Z",
  "deploymentId": "vakw79",
  "lastUpdatedDate": "2016-04-15T18:30:10Z",
  "methodSettings": {},
  "stageName": "prod",
  "variables": {
    "version": "v-prod",
    "url": "petstore-demo-endpoint.execute-api.com/petstore/pets",
    "function": "HelloEveryone"
  }
}
```

## See Also
<a name="API_GetStage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetStage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetStage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetStage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetStage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetStage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetStage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetStage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetStage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetStage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetStage) 

# GetStages
<a name="API_GetStages"></a>

Gets information about one or more Stage resources.

## Request Syntax
<a name="API_GetStages_RequestSyntax"></a>

```
GET /restapis/restapi_id/stages?deploymentId=deploymentId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetStages_RequestParameters"></a>

The request uses the following URI parameters.

 ** [deploymentId](#API_GetStages_RequestSyntax) **   <a name="apigw-GetStages-request-uri-deploymentId"></a>
The stages' deployment identifiers.

 ** [restapi\$1id](#API_GetStages_RequestSyntax) **   <a name="apigw-GetStages-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_GetStages_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetStages_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "accessLogSettings": { 
            "destinationArn": "string",
            "format": "string"
         },
         "cacheClusterEnabled": boolean,
         "cacheClusterSize": "string",
         "cacheClusterStatus": "string",
         "canarySettings": { 
            "deploymentId": "string",
            "percentTraffic": number,
            "stageVariableOverrides": { 
               "string" : "string" 
            },
            "useStageCache": boolean
         },
         "clientCertificateId": "string",
         "createdDate": number,
         "deploymentId": "string",
         "description": "string",
         "documentationVersion": "string",
         "lastUpdatedDate": number,
         "methodSettings": { 
            "string" : { 
               "cacheDataEncrypted": boolean,
               "cacheTtlInSeconds": number,
               "cachingEnabled": boolean,
               "dataTraceEnabled": boolean,
               "loggingLevel": "string",
               "metricsEnabled": boolean,
               "requireAuthorizationForCacheControl": boolean,
               "throttlingBurstLimit": number,
               "throttlingRateLimit": number,
               "unauthorizedCacheControlHeaderStrategy": "string"
            }
         },
         "stageName": "string",
         "tags": { 
            "string" : "string" 
         },
         "tracingEnabled": boolean,
         "variables": { 
            "string" : "string" 
         },
         "webAclArn": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetStages_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetStages_ResponseSyntax) **   <a name="apigw-GetStages-response-item"></a>
The current page of elements from this collection.  
Type: Array of [Stage](API_Stage.md) objects

## Errors
<a name="API_GetStages_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetStages_Examples"></a>

### Get Stages
<a name="API_GetStages_Example_1"></a>

This example illustrates one usage of GetStages.

#### Sample Request
<a name="API_GetStages_Example_1_Request"></a>

```
GET /restapis/{restapi_id}/stages?deployment_id=vakw79 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160524T061752Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160524/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig-hash}
Cache-Control: no-cache
```

#### Sample Response
<a name="API_GetStages_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-stage-{rel}.html",
      "name": "stage",
      "templated": true
    },
    "self": {
      "href": "/restapis/{restapi_id}/stages{?deployment_id}",
      "templated": true
    },
    "item": [
      {
        "href": "/restapis/{restapi_id}/stages/beta"
      },
      {
        "href": "/restapis/{restapi_id}/stages/prod"
      }
    ],
    "stage:by-name": {
      "href": "/restapis/{restapi_id}/stages/{stage_name}",
      "templated": true
    },
    "stage:create": {
      "href": "/restapis/{restapi_id}/stages"
    }
  },
  "_embedded": {
    "item": [
      {
        "_links": {
          "self": {
            "href": "/restapis/{restapi_id}/stages/beta"
          },
          "stage:delete": {
            "href": "/restapis/{restapi_id}/stages/beta"
          },
          "stage:flush-authorizer-cache": {
            "href": "/restapis/{restapi_id}/stages/beta/cache/authorizers"
          },
          "stage:update": {
            "href": "/restapis/{restapi_id}/stages/beta"
          }
        },
        "cacheClusterEnabled": false,
        "cacheClusterStatus": "NOT_AVAILABLE",
        "createdDate": "2016-04-15T17:38:08Z",
        "deploymentId": "vakw79",
        "lastUpdatedDate": "2016-04-15T17:45:48Z",
        "methodSettings": {},
        "stageName": "beta",
        "variables": {
          "version": "v-beta",
          "url": "myDomain.com",
          "function": "HelloWorld"
        }
      },
      {
        "_links": {
          "self": {
            "href": "/restapis/{restapi_id}/stages/prod"
          },
          "stage:delete": {
            "href": "/restapis/{restapi_id}/stages/prod"
          },
          "stage:flush-authorizer-cache": {
            "href": "/restapis/{restapi_id}/stages/prod/cache/authorizers"
          },
          "stage:update": {
            "href": "/restapis/{restapi_id}/stages/prod"
          }
        },
        "cacheClusterEnabled": false,
        "cacheClusterStatus": "NOT_AVAILABLE",
        "createdDate": "2016-04-15T17:53:35Z",
        "deploymentId": "vakw79",
        "lastUpdatedDate": "2016-04-15T18:30:10Z",
        "methodSettings": {},
        "stageName": "prod",
        "variables": {
          "version": "v-prod",
          "url": "petstore-demo-endpoint.execute-api.com/petstore/pets",
          "function": "HelloEveryone"
        }
      }
    ]
  }
}
```

## See Also
<a name="API_GetStages_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetStages) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetStages) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetStages) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetStages) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetStages) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetStages) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetStages) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetStages) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetStages) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetStages) 

# GetTags
<a name="API_GetTags"></a>

Gets the Tags collection for a given resource.

## Request Syntax
<a name="API_GetTags_RequestSyntax"></a>

```
GET /tags/resource_arn?limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetTags_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetTags_RequestSyntax) **   <a name="apigw-GetTags-request-uri-limit"></a>
(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetTags_RequestSyntax) **   <a name="apigw-GetTags-request-uri-position"></a>
(Not currently supported) The current pagination position in the paged result set.

 ** [resource\$1arn](#API_GetTags_RequestSyntax) **   <a name="apigw-GetTags-request-uri-resourceArn"></a>
The ARN of a resource that can be tagged.  
Required: Yes

## Request Body
<a name="API_GetTags_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetTags_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetTags_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_GetTags_ResponseSyntax) **   <a name="apigw-GetTags-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

## Errors
<a name="API_GetTags_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetTags_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetTags) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetTags) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetTags) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetTags) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetTags) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetTags) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetTags) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetTags) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetTags) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetTags) 

# GetUsage
<a name="API_GetUsage"></a>

Gets the usage data of a usage plan in a specified time interval.

## Request Syntax
<a name="API_GetUsage_RequestSyntax"></a>

```
GET /usageplans/usageplanId/usage?endDate=endDate&keyId=keyId&limit=limit&position=position&startDate=startDate HTTP/1.1
```

## URI Request Parameters
<a name="API_GetUsage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [endDate](#API_GetUsage_RequestSyntax) **   <a name="apigw-GetUsage-request-uri-endDate"></a>
The ending date (e.g., 2016-12-31) of the usage data.  
Required: Yes

 ** [keyId](#API_GetUsage_RequestSyntax) **   <a name="apigw-GetUsage-request-uri-keyId"></a>
The Id of the API key associated with the resultant usage data.

 ** [limit](#API_GetUsage_RequestSyntax) **   <a name="apigw-GetUsage-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetUsage_RequestSyntax) **   <a name="apigw-GetUsage-request-uri-position"></a>
The current pagination position in the paged result set.

 ** [startDate](#API_GetUsage_RequestSyntax) **   <a name="apigw-GetUsage-request-uri-startDate"></a>
The starting date (e.g., 2016-01-01) of the usage data.  
Required: Yes

 ** [usageplanId](#API_GetUsage_RequestSyntax) **   <a name="apigw-GetUsage-request-uri-usagePlanId"></a>
The Id of the usage plan associated with the usage data.  
Required: Yes

## Request Body
<a name="API_GetUsage_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetUsage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "endDate": "string",
   "values": { 
      "string" : [ 
         [ number ]
      ]
   },
   "position": "string",
   "startDate": "string",
   "usagePlanId": "string"
}
```

## Response Elements
<a name="API_GetUsage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [endDate](#API_GetUsage_ResponseSyntax) **   <a name="apigw-GetUsage-response-endDate"></a>
The ending date of the usage data.  
Type: String

 ** [values](#API_GetUsage_ResponseSyntax) **   <a name="apigw-GetUsage-response-values"></a>
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 ID and the daily log entry is of the format `[used quota, remaining quota]`.  
Type: String to array of arrays of longs map

 ** [position](#API_GetUsage_ResponseSyntax) **   <a name="apigw-GetUsage-response-position"></a>
The current pagination position in the paged result set.  
Type: String

 ** [startDate](#API_GetUsage_ResponseSyntax) **   <a name="apigw-GetUsage-response-startDate"></a>
The starting date of the usage data.  
Type: String

 ** [usagePlanId](#API_GetUsage_ResponseSyntax) **   <a name="apigw-GetUsage-response-usagePlanId"></a>
The plan Id associated with this usage data.  
Type: String

## Errors
<a name="API_GetUsage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetUsage_Examples"></a>

### Get usage data
<a name="API_GetUsage_Example_1"></a>

This example illustrates one usage of GetUsage.

#### Sample Request
<a name="API_GetUsage_Example_1_Request"></a>

```
GET /usageplans/q2hrol/usage?startDate=2016-08-01&endDate=2016-08-04 HTTP/1.1
Content-Type: application/json
Host: apigateway.ap-southeast-1.amazonaws.com
Content-Length: 254
X-Amz-Date: 20160801T211516Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160801/ap-southeast-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sigv4_hash}
```

#### Sample Response
<a name="API_GetUsage_Example_1_Response"></a>

```
{
  "_links": {
    "self": {
      "href": "/usageplans/q2hrol/usage?startDate=2016-08-01&endDate=2016-08-04"
    },
    "first": {
      "href": "/usageplans/q2hrol/usage?startDate=2016-08-01&endDate=2016-08-04"
    }
  },
  "endDate": "2016-08-04",
  "startDate": "2016-08-01",
  "usagePlanId": "q2hrol",
  "values": {
    "px1KW6TIqK6L8PfqZYR3R3rrFWSS74BB5qBazOJH6": [
      [
        0,
        5000
      ],
      [
        0,
        5000
      ],
      [
        0,
        10
      ],
      [
        0,
        10
      ]
    ]
  }
}
```

## See Also
<a name="API_GetUsage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetUsage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetUsage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetUsage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetUsage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetUsage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetUsage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetUsage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetUsage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetUsage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetUsage) 

# GetUsagePlan
<a name="API_GetUsagePlan"></a>

Gets a usage plan of a given plan identifier.

## Request Syntax
<a name="API_GetUsagePlan_RequestSyntax"></a>

```
GET /usageplans/usageplanId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetUsagePlan_RequestParameters"></a>

The request uses the following URI parameters.

 ** [usageplanId](#API_GetUsagePlan_RequestSyntax) **   <a name="apigw-GetUsagePlan-request-uri-usagePlanId"></a>
The identifier of the UsagePlan resource to be retrieved.  
Required: Yes

## Request Body
<a name="API_GetUsagePlan_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetUsagePlan_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "apiStages": [ 
      { 
         "apiId": "string",
         "stage": "string",
         "throttle": { 
            "string" : { 
               "burstLimit": number,
               "rateLimit": number
            }
         }
      }
   ],
   "description": "string",
   "id": "string",
   "name": "string",
   "productCode": "string",
   "quota": { 
      "limit": number,
      "offset": number,
      "period": "string"
   },
   "tags": { 
      "string" : "string" 
   },
   "throttle": { 
      "burstLimit": number,
      "rateLimit": number
   }
}
```

## Response Elements
<a name="API_GetUsagePlan_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [apiStages](#API_GetUsagePlan_ResponseSyntax) **   <a name="apigw-GetUsagePlan-response-apiStages"></a>
The associated API stages of a usage plan.  
Type: Array of [ApiStage](API_ApiStage.md) objects

 ** [description](#API_GetUsagePlan_ResponseSyntax) **   <a name="apigw-GetUsagePlan-response-description"></a>
The description of a usage plan.  
Type: String

 ** [id](#API_GetUsagePlan_ResponseSyntax) **   <a name="apigw-GetUsagePlan-response-id"></a>
The identifier of a UsagePlan resource.  
Type: String

 ** [name](#API_GetUsagePlan_ResponseSyntax) **   <a name="apigw-GetUsagePlan-response-name"></a>
The name of a usage plan.  
Type: String

 ** [productCode](#API_GetUsagePlan_ResponseSyntax) **   <a name="apigw-GetUsagePlan-response-productCode"></a>
The AWS Marketplace product identifier to associate with the usage plan as a SaaS product on the AWS Marketplace.  
Type: String

 ** [quota](#API_GetUsagePlan_ResponseSyntax) **   <a name="apigw-GetUsagePlan-response-quota"></a>
The target maximum number of permitted requests per a given unit time interval.  
Type: [QuotaSettings](API_QuotaSettings.md) object

 ** [tags](#API_GetUsagePlan_ResponseSyntax) **   <a name="apigw-GetUsagePlan-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [throttle](#API_GetUsagePlan_ResponseSyntax) **   <a name="apigw-GetUsagePlan-response-throttle"></a>
A map containing method level throttling information for API stage in a usage plan.  
Type: [ThrottleSettings](API_ThrottleSettings.md) object

## Errors
<a name="API_GetUsagePlan_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetUsagePlan_Examples"></a>

### Retrieve information about a usage plan
<a name="API_GetUsagePlan_Example_1"></a>

This example illustrates one usage of GetUsagePlan.

#### Sample Request
<a name="API_GetUsagePlan_Example_1_Request"></a>

```
GET /usageplans/n371pt HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160805T012305Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160805/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sigvv4_hash}
Response
```

#### Sample Response
<a name="API_GetUsagePlan_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usage-{rel}.html",
        "name": "usage",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usageplan-{rel}.html",
        "name": "usageplan",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usageplankey-{rel}.html",
        "name": "usageplankey",
        "templated": true
      }
    ],
    "self": {
      "href": "/usageplans/n371pt"
    },
    "usage:get": {
      "href": "/usageplans/n371pt/usage?startDate=2016-07-06&endDate=2016-08-05"
    },
    "usageplan:delete": {
      "href": "/usageplans/n371pt"
    },
    "usageplan:update": {
      "href": "/usageplans/n371pt"
    },
    "usageplan:usageplankeys": {
      "href": "/usageplans/n371pt/keys"
    },
    "usageplankey:create": {
      "href": "/usageplans/n371pt/keys"
    }
  },
  "apiStages": {
    "stage": "testStage",
    "apiId": "kdwpu39c2k"
  },
  "id": "n371pt",
  "name": "Plan_D",
  "quota": {
    "period": "DAY",
    "offset": 0,
    "limit": 5
  },
  "throttle": {
    "rateLimit": 100,
    "burstLimit": 200
  }
}
```

## See Also
<a name="API_GetUsagePlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetUsagePlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetUsagePlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetUsagePlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetUsagePlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetUsagePlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetUsagePlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetUsagePlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetUsagePlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetUsagePlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetUsagePlan) 

# GetUsagePlanKey
<a name="API_GetUsagePlanKey"></a>

Gets a usage plan key of a given key identifier.

## Request Syntax
<a name="API_GetUsagePlanKey_RequestSyntax"></a>

```
GET /usageplans/usageplanId/keys/keyId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetUsagePlanKey_RequestParameters"></a>

The request uses the following URI parameters.

 ** [keyId](#API_GetUsagePlanKey_RequestSyntax) **   <a name="apigw-GetUsagePlanKey-request-uri-keyId"></a>
The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.  
Required: Yes

 ** [usageplanId](#API_GetUsagePlanKey_RequestSyntax) **   <a name="apigw-GetUsagePlanKey-request-uri-usagePlanId"></a>
The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.  
Required: Yes

## Request Body
<a name="API_GetUsagePlanKey_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetUsagePlanKey_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "id": "string",
   "name": "string",
   "type": "string",
   "value": "string"
}
```

## Response Elements
<a name="API_GetUsagePlanKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [id](#API_GetUsagePlanKey_ResponseSyntax) **   <a name="apigw-GetUsagePlanKey-response-id"></a>
The Id of a usage plan key.  
Type: String

 ** [name](#API_GetUsagePlanKey_ResponseSyntax) **   <a name="apigw-GetUsagePlanKey-response-name"></a>
The name of a usage plan key.  
Type: String

 ** [type](#API_GetUsagePlanKey_ResponseSyntax) **   <a name="apigw-GetUsagePlanKey-response-type"></a>
The type of a usage plan key. Currently, the valid key type is `API_KEY`.  
Type: String

 ** [value](#API_GetUsagePlanKey_ResponseSyntax) **   <a name="apigw-GetUsagePlanKey-response-value"></a>
The value of a usage plan key.  
Type: String

## Errors
<a name="API_GetUsagePlanKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetUsagePlanKey_Examples"></a>

### Retrieve a usage plan key
<a name="API_GetUsagePlanKey_Example_1"></a>

This example illustrates one usage of GetUsagePlanKey.

#### Sample Request
<a name="API_GetUsagePlanKey_Example_1_Request"></a>

```
GET /usageplans/n371pt/keys/4wj0d1lt91 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
Content-Length: 58
X-Amz-Date: 20160805T180524Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160805/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sigv4_hash}
Response
```

#### Sample Response
<a name="API_GetUsagePlanKey_Example_1_Response"></a>

```
{
  "_links": {
    "self": {
      "href": "/usageplans/n371pt/keys/4wj0d1lt91"
    }
  },
  "id": "4wj0d1lt91",
  "name": "MyApiKey",
  "type": "API_KEY"
}
```

## See Also
<a name="API_GetUsagePlanKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetUsagePlanKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetUsagePlanKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetUsagePlanKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetUsagePlanKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetUsagePlanKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetUsagePlanKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetUsagePlanKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetUsagePlanKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetUsagePlanKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetUsagePlanKey) 

# GetUsagePlanKeys
<a name="API_GetUsagePlanKeys"></a>

Gets all the usage plan keys representing the API keys added to a specified usage plan.

## Request Syntax
<a name="API_GetUsagePlanKeys_RequestSyntax"></a>

```
GET /usageplans/usageplanId/keys?limit=limit&name=nameQuery&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetUsagePlanKeys_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetUsagePlanKeys_RequestSyntax) **   <a name="apigw-GetUsagePlanKeys-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [nameQuery](#API_GetUsagePlanKeys_RequestSyntax) **   <a name="apigw-GetUsagePlanKeys-request-uri-nameQuery"></a>
A query parameter specifying the name of the to-be-returned usage plan keys.

 ** [position](#API_GetUsagePlanKeys_RequestSyntax) **   <a name="apigw-GetUsagePlanKeys-request-uri-position"></a>
The current pagination position in the paged result set.

 ** [usageplanId](#API_GetUsagePlanKeys_RequestSyntax) **   <a name="apigw-GetUsagePlanKeys-request-uri-usagePlanId"></a>
The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.  
Required: Yes

## Request Body
<a name="API_GetUsagePlanKeys_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetUsagePlanKeys_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "id": "string",
         "name": "string",
         "type": "string",
         "value": "string"
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetUsagePlanKeys_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetUsagePlanKeys_ResponseSyntax) **   <a name="apigw-GetUsagePlanKeys-response-item"></a>
The current page of elements from this collection.  
Type: Array of [UsagePlanKey](API_UsagePlanKey.md) objects

 ** [position](#API_GetUsagePlanKeys_ResponseSyntax) **   <a name="apigw-GetUsagePlanKeys-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetUsagePlanKeys_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetUsagePlanKeys_Examples"></a>

### Retrieve usage plan keys
<a name="API_GetUsagePlanKeys_Example_1"></a>

This example illustrates one usage of GetUsagePlanKeys.

#### Sample Request
<a name="API_GetUsagePlanKeys_Example_1_Request"></a>

```
GET /usageplans/n371pt/keys HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
Content-Length: 58
X-Amz-Date: 20160805T185459Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160805/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sigv4_hash}
Response
```

#### Sample Response
<a name="API_GetUsagePlanKeys_Example_1_Response"></a>

```
{
  "_links": {
    "self": {
      "href": "/usageplans/n371pt/keys"
    },
    "item": {
      "href": "/usageplans/n371pt/keys/4wj0d1lt91"
    }
  },
  "_embedded": {
    "item": {
      "_links": {
        "self": {
          "href": "/usageplans/n371pt/keys/4wj0d1lt91"
        }
      },
      "id": "4wj0d1lt91",
      "name": "MyApiKey",
      "type": "API_KEY"
    }
  }
}
```

## See Also
<a name="API_GetUsagePlanKeys_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetUsagePlanKeys) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetUsagePlanKeys) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetUsagePlanKeys) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetUsagePlanKeys) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetUsagePlanKeys) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetUsagePlanKeys) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetUsagePlanKeys) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetUsagePlanKeys) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetUsagePlanKeys) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetUsagePlanKeys) 

# GetUsagePlans
<a name="API_GetUsagePlans"></a>

Gets all the usage plans of the caller's account.

## Request Syntax
<a name="API_GetUsagePlans_RequestSyntax"></a>

```
GET /usageplans?keyId=keyId&limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetUsagePlans_RequestParameters"></a>

The request uses the following URI parameters.

 ** [keyId](#API_GetUsagePlans_RequestSyntax) **   <a name="apigw-GetUsagePlans-request-uri-keyId"></a>
The identifier of the API key associated with the usage plans.

 ** [limit](#API_GetUsagePlans_RequestSyntax) **   <a name="apigw-GetUsagePlans-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetUsagePlans_RequestSyntax) **   <a name="apigw-GetUsagePlans-request-uri-position"></a>
The current pagination position in the paged result set.

## Request Body
<a name="API_GetUsagePlans_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetUsagePlans_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "apiStages": [ 
            { 
               "apiId": "string",
               "stage": "string",
               "throttle": { 
                  "string" : { 
                     "burstLimit": number,
                     "rateLimit": number
                  }
               }
            }
         ],
         "description": "string",
         "id": "string",
         "name": "string",
         "productCode": "string",
         "quota": { 
            "limit": number,
            "offset": number,
            "period": "string"
         },
         "tags": { 
            "string" : "string" 
         },
         "throttle": { 
            "burstLimit": number,
            "rateLimit": number
         }
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetUsagePlans_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetUsagePlans_ResponseSyntax) **   <a name="apigw-GetUsagePlans-response-item"></a>
The current page of elements from this collection.  
Type: Array of [UsagePlan](API_UsagePlan.md) objects

 ** [position](#API_GetUsagePlans_ResponseSyntax) **   <a name="apigw-GetUsagePlans-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetUsagePlans_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_GetUsagePlans_Examples"></a>

### Retrieve usage plans
<a name="API_GetUsagePlans_Example_1"></a>

 The following example request gets the UsagePlans of the caller's account. 

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

#### Sample Request
<a name="API_GetUsagePlans_Example_1_Request"></a>

```
GET /usageplans HTTP/1.1
Content-Type: application/json
Host: apigateway.ap-southeast-1.amazonaws.com
Content-Length: 254
X-Amz-Date: 20160801T204414Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160801/ap-southeast-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sigv4_hash}
```

#### Sample Response
<a name="API_GetUsagePlans_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usage-{rel}.html",
        "name": "usage",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usageplan-{rel}.html",
        "name": "usageplan",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usageplankey-{rel}.html",
        "name": "usageplankey",
        "templated": true
      }
    ],
    "self": {
      "href": "/usageplans"
    },
    "item": {
      "href": "/usageplans/ywbqww"
    },
    "usageplan:by-id": {
      "href": "/usageplans/{usageplanId}",
      "templated": true
    },
    "usageplan:create": {
      "href": "/usageplans"
    }
  },
  "_embedded": {
    "item": {
      "_links": {
        "self": {
          "href": "/usageplans/ywbqww"
        },
        "usage:get": {
          "href": "/usageplans/ywbqww/usage?startDate=2016-07-02&endDate=2016-08-01"
        },
        "usageplan:delete": {
          "href": "/usageplans/ywbqww"
        },
        "usageplan:update": {
          "href": "/usageplans/ywbqww"
        },
        "usageplan:usageplankeys": {
          "href": "/usageplans/ywbqww/keys"
        },
        "usageplankey:create": {
          "href": "/usageplans/ywbqww/keys"
        }
      },
      "apiStages": {
        "stage": "testStage",
        "apiId": "xbvxlpijch"
      },
      "description": "Plan A",
      "id": "ywbqww",
      "name": "Plan_A",
      "quota": {
        "period": "MONTH",
        "offset": 0,
        "limit": 1000
      },
      "throttle": {
        "rateLimit": 100,
        "burstLimit": 200
      }
    }
  }
}
```

## See Also
<a name="API_GetUsagePlans_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetUsagePlans) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetUsagePlans) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetUsagePlans) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetUsagePlans) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetUsagePlans) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetUsagePlans) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetUsagePlans) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetUsagePlans) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetUsagePlans) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetUsagePlans) 

# GetVpcLink
<a name="API_GetVpcLink"></a>

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

## Request Syntax
<a name="API_GetVpcLink_RequestSyntax"></a>

```
GET /vpclinks/vpclink_id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetVpcLink_RequestParameters"></a>

The request uses the following URI parameters.

 ** [vpclink\$1id](#API_GetVpcLink_RequestSyntax) **   <a name="apigw-GetVpcLink-request-uri-vpcLinkId"></a>
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.  
Required: Yes

## Request Body
<a name="API_GetVpcLink_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetVpcLink_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "description": "string",
   "id": "string",
   "name": "string",
   "status": "string",
   "statusMessage": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetArns": [ "string" ]
}
```

## Response Elements
<a name="API_GetVpcLink_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [description](#API_GetVpcLink_ResponseSyntax) **   <a name="apigw-GetVpcLink-response-description"></a>
The description of the VPC link.  
Type: String

 ** [id](#API_GetVpcLink_ResponseSyntax) **   <a name="apigw-GetVpcLink-response-id"></a>
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.  
Type: String

 ** [name](#API_GetVpcLink_ResponseSyntax) **   <a name="apigw-GetVpcLink-response-name"></a>
The name used to label and identify the VPC link.  
Type: String

 ** [status](#API_GetVpcLink_ResponseSyntax) **   <a name="apigw-GetVpcLink-response-status"></a>
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`.   
Type: String  
Valid Values: `AVAILABLE | PENDING | DELETING | FAILED` 

 ** [statusMessage](#API_GetVpcLink_ResponseSyntax) **   <a name="apigw-GetVpcLink-response-statusMessage"></a>
A description about the VPC link status.  
Type: String

 ** [tags](#API_GetVpcLink_ResponseSyntax) **   <a name="apigw-GetVpcLink-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [targetArns](#API_GetVpcLink_ResponseSyntax) **   <a name="apigw-GetVpcLink-response-targetArns"></a>
The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.  
Type: Array of strings

## Errors
<a name="API_GetVpcLink_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetVpcLink_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetVpcLink) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetVpcLink) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetVpcLink) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetVpcLink) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetVpcLink) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetVpcLink) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetVpcLink) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetVpcLink) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetVpcLink) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetVpcLink) 

# GetVpcLinks
<a name="API_GetVpcLinks"></a>

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

## Request Syntax
<a name="API_GetVpcLinks_RequestSyntax"></a>

```
GET /vpclinks?limit=limit&position=position HTTP/1.1
```

## URI Request Parameters
<a name="API_GetVpcLinks_RequestParameters"></a>

The request uses the following URI parameters.

 ** [limit](#API_GetVpcLinks_RequestSyntax) **   <a name="apigw-GetVpcLinks-request-uri-limit"></a>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 ** [position](#API_GetVpcLinks_RequestSyntax) **   <a name="apigw-GetVpcLinks-request-uri-position"></a>
The current pagination position in the paged result set.

## Request Body
<a name="API_GetVpcLinks_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetVpcLinks_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "item": [ 
      { 
         "description": "string",
         "id": "string",
         "name": "string",
         "status": "string",
         "statusMessage": "string",
         "tags": { 
            "string" : "string" 
         },
         "targetArns": [ "string" ]
      }
   ],
   "position": "string"
}
```

## Response Elements
<a name="API_GetVpcLinks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [item](#API_GetVpcLinks_ResponseSyntax) **   <a name="apigw-GetVpcLinks-response-item"></a>
The current page of elements from this collection.  
Type: Array of [VpcLink](API_VpcLink.md) objects

 ** [position](#API_GetVpcLinks_ResponseSyntax) **   <a name="apigw-GetVpcLinks-response-position"></a>
The current pagination position in the paged result set.  
Type: String

## Errors
<a name="API_GetVpcLinks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_GetVpcLinks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/GetVpcLinks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/GetVpcLinks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/GetVpcLinks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/GetVpcLinks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/GetVpcLinks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/GetVpcLinks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/GetVpcLinks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/GetVpcLinks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/GetVpcLinks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/GetVpcLinks) 

# ImportApiKeys
<a name="API_ImportApiKeys"></a>

Import API keys from an external source, such as a CSV-formatted file.

## Request Syntax
<a name="API_ImportApiKeys_RequestSyntax"></a>

```
POST /apikeys?mode=import&failonwarnings=failOnWarnings&format=format HTTP/1.1

body
```

## URI Request Parameters
<a name="API_ImportApiKeys_RequestParameters"></a>

The request uses the following URI parameters.

 ** [failOnWarnings](#API_ImportApiKeys_RequestSyntax) **   <a name="apigw-ImportApiKeys-request-uri-failOnWarnings"></a>
A query parameter to indicate whether to rollback ApiKey importation (`true`) or not (`false`) when error is encountered.

 ** [format](#API_ImportApiKeys_RequestSyntax) **   <a name="apigw-ImportApiKeys-request-uri-format"></a>
A query parameter to specify the input format to imported API keys. Currently, only the `csv` format is supported.  
Valid Values: `csv`   
Required: Yes

## Request Body
<a name="API_ImportApiKeys_RequestBody"></a>

The request accepts the following binary data.

 ** [body](#API_ImportApiKeys_RequestSyntax) **   <a name="apigw-ImportApiKeys-request-body"></a>
The payload of the POST request to import API keys. For the payload format, see API Key File Format.  
Required: Yes

## Response Syntax
<a name="API_ImportApiKeys_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "ids": [ "string" ],
   "warnings": [ "string" ]
}
```

## Response Elements
<a name="API_ImportApiKeys_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [ids](#API_ImportApiKeys_ResponseSyntax) **   <a name="apigw-ImportApiKeys-response-ids"></a>
A list of all the ApiKey identifiers.  
Type: Array of strings

 ** [warnings](#API_ImportApiKeys_ResponseSyntax) **   <a name="apigw-ImportApiKeys-response-warnings"></a>
A list of warning messages.  
Type: Array of strings

## Errors
<a name="API_ImportApiKeys_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_ImportApiKeys_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/ImportApiKeys) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/ImportApiKeys) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/ImportApiKeys) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/ImportApiKeys) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/ImportApiKeys) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/ImportApiKeys) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/ImportApiKeys) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/ImportApiKeys) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/ImportApiKeys) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/ImportApiKeys) 

# ImportDocumentationParts
<a name="API_ImportDocumentationParts"></a>

Imports documentation parts

## Request Syntax
<a name="API_ImportDocumentationParts_RequestSyntax"></a>

```
PUT /restapis/restapi_id/documentation/parts?failonwarnings=failOnWarnings&mode=mode HTTP/1.1

body
```

## URI Request Parameters
<a name="API_ImportDocumentationParts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [failOnWarnings](#API_ImportDocumentationParts_RequestSyntax) **   <a name="apigw-ImportDocumentationParts-request-uri-failOnWarnings"></a>
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`.

 ** [mode](#API_ImportDocumentationParts_RequestSyntax) **   <a name="apigw-ImportDocumentationParts-request-uri-mode"></a>
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`.  
Valid Values: `merge | overwrite` 

 ** [restapi\$1id](#API_ImportDocumentationParts_RequestSyntax) **   <a name="apigw-ImportDocumentationParts-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_ImportDocumentationParts_RequestBody"></a>

The request accepts the following binary data.

 ** [body](#API_ImportDocumentationParts_RequestSyntax) **   <a name="apigw-ImportDocumentationParts-request-body"></a>
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.  
Required: Yes

## Response Syntax
<a name="API_ImportDocumentationParts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ids": [ "string" ],
   "warnings": [ "string" ]
}
```

## Response Elements
<a name="API_ImportDocumentationParts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ids](#API_ImportDocumentationParts_ResponseSyntax) **   <a name="apigw-ImportDocumentationParts-response-ids"></a>
A list of the returned documentation part identifiers.  
Type: Array of strings

 ** [warnings](#API_ImportDocumentationParts_ResponseSyntax) **   <a name="apigw-ImportDocumentationParts-response-warnings"></a>
A list of warning messages reported during import of documentation parts.  
Type: Array of strings

## Errors
<a name="API_ImportDocumentationParts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_ImportDocumentationParts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/ImportDocumentationParts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/ImportDocumentationParts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/ImportDocumentationParts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/ImportDocumentationParts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/ImportDocumentationParts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/ImportDocumentationParts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/ImportDocumentationParts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/ImportDocumentationParts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/ImportDocumentationParts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/ImportDocumentationParts) 

# ImportRestApi
<a name="API_ImportRestApi"></a>

A feature of the API Gateway control service for creating a new API from an external API definition file.

## Request Syntax
<a name="API_ImportRestApi_RequestSyntax"></a>

```
POST /restapis?mode=import&parameters&failonwarnings=failOnWarnings HTTP/1.1

body
```

## URI Request Parameters
<a name="API_ImportRestApi_RequestParameters"></a>

The request uses the following URI parameters.

 ** [failOnWarnings](#API_ImportRestApi_RequestSyntax) **   <a name="apigw-ImportRestApi-request-uri-failOnWarnings"></a>
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`.

 ** [parameters](#API_ImportRestApi_RequestSyntax) **   <a name="apigw-ImportRestApi-request-uri-parameters"></a>
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`, `endpointConfigurationTypes=REGIONAL`, or `endpointConfigurationTypes=PRIVATE`. The default endpoint type is `EDGE`.  
 To handle imported `basepath`, set `parameters` as `basepath=ignore`, `basepath=prepend` or `basepath=split`.

## Request Body
<a name="API_ImportRestApi_RequestBody"></a>

The request accepts the following binary data.

 ** [body](#API_ImportRestApi_RequestSyntax) **   <a name="apigw-ImportRestApi-request-body"></a>
The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.  
Required: Yes

## Response Syntax
<a name="API_ImportRestApi_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "apiKeySource": "string",
   "apiStatus": "string",
   "apiStatusMessage": "string",
   "binaryMediaTypes": [ "string" ],
   "createdDate": number,
   "description": "string",
   "disableExecuteApiEndpoint": boolean,
   "endpointAccessMode": "string",
   "endpointConfiguration": { 
      "ipAddressType": "string",
      "types": [ "string" ],
      "vpcEndpointIds": [ "string" ]
   },
   "id": "string",
   "minimumCompressionSize": number,
   "name": "string",
   "policy": "string",
   "rootResourceId": "string",
   "securityPolicy": "string",
   "tags": { 
      "string" : "string" 
   },
   "version": "string",
   "warnings": [ "string" ]
}
```

## Response Elements
<a name="API_ImportRestApi_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [apiKeySource](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-apiKeySource"></a>
The source of the API key for metering requests according to a usage plan. Valid values are: >`HEADER` to read the API key from the `X-API-Key` header of a request. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer.  
Type: String  
Valid Values: `HEADER | AUTHORIZER` 

 ** [apiStatus](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-apiStatus"></a>
The ApiStatus of the RestApi.   
Type: String  
Valid Values: `UPDATING | AVAILABLE | PENDING | FAILED` 

 ** [apiStatusMessage](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-apiStatusMessage"></a>
 The status message of the RestApi. When the status message is `UPDATING` you can still invoke it.   
Type: String

 ** [binaryMediaTypes](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-binaryMediaTypes"></a>
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.  
Type: Array of strings

 ** [createdDate](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-createdDate"></a>
The timestamp when the API was created.  
Type: Timestamp

 ** [description](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-description"></a>
The API's description.  
Type: String

 ** [disableExecuteApiEndpoint](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-disableExecuteApiEndpoint"></a>
Specifies whether clients can invoke your API by using the default `execute-api` endpoint. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.  
Type: Boolean

 ** [endpointAccessMode](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-endpointAccessMode"></a>
 The endpoint access mode of the RestApi.   
Type: String  
Valid Values: `BASIC | STRICT` 

 ** [endpointConfiguration](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-endpointConfiguration"></a>
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.   
Type: [EndpointConfiguration](API_EndpointConfiguration.md) object

 ** [id](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-id"></a>
The API's identifier. This identifier is unique across all of your APIs in API Gateway.  
Type: String

 ** [minimumCompressionSize](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-minimumCompressionSize"></a>
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.  
Type: Integer

 ** [name](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-name"></a>
The API's name.  
Type: String

 ** [policy](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-policy"></a>
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.  
Type: String

 ** [rootResourceId](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-rootResourceId"></a>
The API's root resource ID.  
Type: String

 ** [securityPolicy](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-securityPolicy"></a>
 The Transport Layer Security (TLS) version \$1 cipher suite for this RestApi.   
Type: String  
Valid Values: `TLS_1_0 | TLS_1_2 | SecurityPolicy_TLS13_1_3_2025_09 | SecurityPolicy_TLS13_1_3_FIPS_2025_09 | SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_PQ_2025_09 | SecurityPolicy_TLS13_1_2_2021_06 | SecurityPolicy_TLS13_2025_EDGE | SecurityPolicy_TLS12_PFS_2025_EDGE | SecurityPolicy_TLS12_2018_EDGE` 

 ** [tags](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [version](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-version"></a>
A version identifier for the API.  
Type: String

 ** [warnings](#API_ImportRestApi_ResponseSyntax) **   <a name="apigw-ImportRestApi-response-warnings"></a>
The warning messages reported when `failonwarnings` is turned on during API import.  
Type: Array of strings

## Errors
<a name="API_ImportRestApi_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_ImportRestApi_Examples"></a>

### Import an OpenAPI API definition
<a name="API_ImportRestApi_Example_1"></a>

This example illustrates one usage of ImportRestApi.

#### Sample Request
<a name="API_ImportRestApi_Example_1_Request"></a>

```
POST /restapis?mode=import&failonwarning=true&basepath=ignore HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160606T234936Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160606/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "swagger": "2.0",
  "info": {
    "version": "2016-06-06T23:48:44Z",
    "title": "my-sample-api"
  },
  "host": "fugvjdxtri.execute-api.us-east-1.amazonaws.com",
  "basepath": "/stage2",
  "schemes": [
    "https"
  ],
  "paths": {
    "/": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "200 response",
            "schema": {
              "$ref": "#/definitions/Empty"
            },
            "headers": {
              "Content-Type": {
                "type": "string"
              }
            }
          }
        },
        "x-amazon-apigateway-integration": {
          "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole",
          "responses": {
            "default": {
              "statusCode": "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"
              }
            }
          },
          "requestTemplates": {
            "application/json": "{\n}"
          },
          "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams",
          "passthroughBehavior": "when_no_match",
          "httpMethod": "POST",
          "requestParameters": {
            "integration.request.header.Content-Type": "'application/x-amz-json-1.1'"
          },
          "type": "aws"
        }
      }
    }
  },
  "definitions": {
    "Empty": {
      "type": "object"
    }
  }
}
```

#### Sample Response
<a name="API_ImportRestApi_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-authorizer-{rel}.html",
        "name": "authorizer",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-deployment-{rel}.html",
        "name": "deployment",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-model-{rel}.html",
        "name": "model",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-resource-{rel}.html",
        "name": "resource",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-restapi-{rel}.html",
        "name": "restapi",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-stage-{rel}.html",
        "name": "stage",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis/wn611yeyp3"
    },
    "authorizer:by-id": {
      "href": "/restapis/wn611yeyp3/authorizers/{authorizer_id}",
      "templated": true
    },
    "authorizer:create": {
      "href": "/restapis/wn611yeyp3/authorizers"
    },
    "deployment:by-id": {
      "href": "/restapis/wn611yeyp3/deployments/{deployment_id}{?embed}",
      "templated": true
    },
    "deployment:create": {
      "href": "/restapis/wn611yeyp3/deployments"
    },
    "model:by-name": {
      "href": "/restapis/wn611yeyp3/models/{model_name}?flatten=false",
      "templated": true
    },
    "model:create": {
      "href": "/restapis/wn611yeyp3/models"
    },
    "resource:by-id": {
      "href": "/restapis/wn611yeyp3/resources/{resource_id}{?embed}",
      "templated": true
    },
    "resource:create": {
      "href": "/restapis/wn611yeyp3/resources/s3dmsjgijc"
    },
    "restapi:authorizers": {
      "href": "/restapis/wn611yeyp3/authorizers"
    },
    "restapi:delete": {
      "href": "/restapis/wn611yeyp3"
    },
    "restapi:deployments": {
      "href": "/restapis/wn611yeyp3/deployments{?limit}",
      "templated": true
    },
    "restapi:models": {
      "href": "/restapis/wn611yeyp3/models"
    },
    "restapi:resources": {
      "href": "/restapis/wn611yeyp3/resources{?limit,embed}",
      "templated": true
    },
    "restapi:stages": {
      "href": "/restapis/wn611yeyp3/stages{?deployment_id}",
      "templated": true
    },
    "restapi:update": {
      "href": "/restapis/wn611yeyp3"
    },
    "stage:by-name": {
      "href": "/restapis/wn611yeyp3/stages/{stage_name}",
      "templated": true
    },
    "stage:create": {
      "href": "/restapis/wn611yeyp3/stages"
    }
  },
  "createdDate": "2016-06-06T23:49:37Z",
  "id": "wn611yeyp3",
  "name": "my-sample-api"
}
```

## See Also
<a name="API_ImportRestApi_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/ImportRestApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/ImportRestApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/ImportRestApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/ImportRestApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/ImportRestApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/ImportRestApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/ImportRestApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/ImportRestApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/ImportRestApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/ImportRestApi) 

# PutGatewayResponse
<a name="API_PutGatewayResponse"></a>

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

## Request Syntax
<a name="API_PutGatewayResponse_RequestSyntax"></a>

```
PUT /restapis/restapi_id/gatewayresponses/response_type HTTP/1.1
Content-type: application/json

{
   "responseParameters": { 
      "string" : "string" 
   },
   "responseTemplates": { 
      "string" : "string" 
   },
   "statusCode": "string"
}
```

## URI Request Parameters
<a name="API_PutGatewayResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [response\$1type](#API_PutGatewayResponse_RequestSyntax) **   <a name="apigw-PutGatewayResponse-request-uri-responseType"></a>
The response type of the associated GatewayResponse  
Valid Values: `DEFAULT_4XX | DEFAULT_5XX | RESOURCE_NOT_FOUND | UNAUTHORIZED | INVALID_API_KEY | ACCESS_DENIED | AUTHORIZER_FAILURE | AUTHORIZER_CONFIGURATION_ERROR | INVALID_SIGNATURE | EXPIRED_TOKEN | MISSING_AUTHENTICATION_TOKEN | INTEGRATION_FAILURE | INTEGRATION_TIMEOUT | API_CONFIGURATION_ERROR | UNSUPPORTED_MEDIA_TYPE | BAD_REQUEST_PARAMETERS | BAD_REQUEST_BODY | REQUEST_TOO_LARGE | THROTTLED | QUOTA_EXCEEDED | WAF_FILTERED`   
Required: Yes

 ** [restapi\$1id](#API_PutGatewayResponse_RequestSyntax) **   <a name="apigw-PutGatewayResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_PutGatewayResponse_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [responseParameters](#API_PutGatewayResponse_RequestSyntax) **   <a name="apigw-PutGatewayResponse-request-responseParameters"></a>
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.  
Type: String to string map  
Required: No

 ** [responseTemplates](#API_PutGatewayResponse_RequestSyntax) **   <a name="apigw-PutGatewayResponse-request-responseTemplates"></a>
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.  
Type: String to string map  
Required: No

 ** [statusCode](#API_PutGatewayResponse_RequestSyntax) **   <a name="apigw-PutGatewayResponse-request-statusCode"></a>
The HTTP status code of the GatewayResponse.  
Type: String  
Pattern: `[1-5]\d\d`   
Required: No

## Response Syntax
<a name="API_PutGatewayResponse_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "defaultResponse": boolean,
   "responseParameters": { 
      "string" : "string" 
   },
   "responseTemplates": { 
      "string" : "string" 
   },
   "responseType": "string",
   "statusCode": "string"
}
```

## Response Elements
<a name="API_PutGatewayResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [defaultResponse](#API_PutGatewayResponse_ResponseSyntax) **   <a name="apigw-PutGatewayResponse-response-defaultResponse"></a>
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.   
Type: Boolean

 ** [responseParameters](#API_PutGatewayResponse_ResponseSyntax) **   <a name="apigw-PutGatewayResponse-response-responseParameters"></a>
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.  
Type: String to string map

 ** [responseTemplates](#API_PutGatewayResponse_ResponseSyntax) **   <a name="apigw-PutGatewayResponse-response-responseTemplates"></a>
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.  
Type: String to string map

 ** [responseType](#API_PutGatewayResponse_ResponseSyntax) **   <a name="apigw-PutGatewayResponse-response-responseType"></a>
The response type of the associated GatewayResponse.  
Type: String  
Valid Values: `DEFAULT_4XX | DEFAULT_5XX | RESOURCE_NOT_FOUND | UNAUTHORIZED | INVALID_API_KEY | ACCESS_DENIED | AUTHORIZER_FAILURE | AUTHORIZER_CONFIGURATION_ERROR | INVALID_SIGNATURE | EXPIRED_TOKEN | MISSING_AUTHENTICATION_TOKEN | INTEGRATION_FAILURE | INTEGRATION_TIMEOUT | API_CONFIGURATION_ERROR | UNSUPPORTED_MEDIA_TYPE | BAD_REQUEST_PARAMETERS | BAD_REQUEST_BODY | REQUEST_TOO_LARGE | THROTTLED | QUOTA_EXCEEDED | WAF_FILTERED` 

 ** [statusCode](#API_PutGatewayResponse_ResponseSyntax) **   <a name="apigw-PutGatewayResponse-response-statusCode"></a>
The HTTP status code for this GatewayResponse.  
Type: String  
Pattern: `[1-5]\d\d` 

## Errors
<a name="API_PutGatewayResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_PutGatewayResponse_Examples"></a>

### Set up a Gateway Response of a given response type
<a name="API_PutGatewayResponse_Example_1"></a>

This example illustrates one usage of PutGatewayResponse.

#### Sample Request
<a name="API_PutGatewayResponse_Example_1_Request"></a>

```
PUT /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1
Host: beta-apigateway.us-east-1.amazonaws.com
Content-Type: application/json
X-Amz-Date: 20170503T201609Z
Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=15e138ede132fa8c35c665412f407bd23a9993bdc79b3bef22f1ccccc4c6fac1
Cache-Control: no-cache
Postman-Token: 639177c3-627e-3566-a367-7746659d2360

{
  "statusCode" : "404",
  "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}"
  }
}
```

#### Sample Response
<a name="API_PutGatewayResponse_Example_1_Response"></a>

```
{
  "_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"
}
```

## See Also
<a name="API_PutGatewayResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/PutGatewayResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/PutGatewayResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/PutGatewayResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/PutGatewayResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/PutGatewayResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/PutGatewayResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/PutGatewayResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/PutGatewayResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutGatewayResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/PutGatewayResponse) 

# PutIntegration
<a name="API_PutIntegration"></a>

Sets up a method's integration.

## Request Syntax
<a name="API_PutIntegration_RequestSyntax"></a>

```
PUT /restapis/restapi_id/resources/resource_id/methods/http_method/integration HTTP/1.1
Content-type: application/json

{
   "cacheKeyParameters": [ "string" ],
   "cacheNamespace": "string",
   "connectionId": "string",
   "connectionType": "string",
   "contentHandling": "string",
   "credentials": "string",
   "httpMethod": "string",
   "integrationTarget": "string",
   "passthroughBehavior": "string",
   "requestParameters": { 
      "string" : "string" 
   },
   "requestTemplates": { 
      "string" : "string" 
   },
   "responseTransferMode": "string",
   "timeoutInMillis": number,
   "tlsConfig": { 
      "insecureSkipVerification": boolean
   },
   "type": "string",
   "uri": "string"
}
```

## URI Request Parameters
<a name="API_PutIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-uri-method"></a>
Specifies the HTTP method for the integration.  
Required: Yes

 ** [resource\$1id](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-uri-resourceId"></a>
Specifies a put integration request's resource ID.  
Required: Yes

 ** [restapi\$1id](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_PutIntegration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [cacheKeyParameters](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-cacheKeyParameters"></a>
A list of request parameters whose values API Gateway caches. To be valid values for `cacheKeyParameters`, these parameters must also be specified for Method `requestParameters`.  
Type: Array of strings  
Required: No

 ** [cacheNamespace](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-cacheNamespace"></a>
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the `cacheNamespace`. You can specify the same `cacheNamespace` across resources to return the same cached data for requests to different resources.  
Type: String  
Required: No

 ** [connectionId](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-connectionId"></a>
The ID of the VpcLink used for the integration. Specify this value only if you specify `VPC_LINK` as the connection type.  
Type: String  
Required: No

 ** [connectionType](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-connectionType"></a>
The type of the network connection to the integration endpoint. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.  
Type: String  
Valid Values: `INTERNET | VPC_LINK`   
Required: No

 ** [contentHandling](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-contentHandling"></a>
Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors:  
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass-through.  
Type: String  
Valid Values: `CONVERT_TO_BINARY | CONVERT_TO_TEXT`   
Required: No

 ** [credentials](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-credentials"></a>
Specifies whether credentials are required for a put integration.  
Type: String  
Required: No

 ** [httpMethod](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-httpMethod"></a>
The HTTP method for the integration.  
Type: String  
Required: No

 ** [integrationTarget](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-integrationTarget"></a>
 The ALB or NLB listener to send the request to.   
Type: String  
Required: No

 ** [passthroughBehavior](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-passthroughBehavior"></a>
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`.   
Type: String  
Required: No

 ** [requestParameters](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-requestParameters"></a>
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.  
Type: String to string map  
Required: No

 ** [requestTemplates](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-requestTemplates"></a>
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.  
Type: String to string map  
Required: No

 ** [responseTransferMode](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-responseTransferMode"></a>
 The response transfer mode of the integration.   
Type: String  
Valid Values: `BUFFERED | STREAM`   
Required: No

 ** [timeoutInMillis](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-timeoutInMillis"></a>
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.  
Type: Integer  
Required: No

 ** [tlsConfig](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-tlsConfig"></a>
Specifies the TLS configuration for an integration.  
Type: [TlsConfig](API_TlsConfig.md) object  
Required: No

 ** [type](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-type"></a>
Specifies a put integration input's type.  
Type: String  
Valid Values: `HTTP | AWS | MOCK | HTTP_PROXY | AWS_PROXY`   
Required: Yes

 ** [uri](#API_PutIntegration_RequestSyntax) **   <a name="apigw-PutIntegration-request-uri"></a>
Specifies the 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, and use a valid top-level domain. For a private HTTP integration with a `connectionType` of `VPC_LINK`, 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`\$1. Here, \$1Region\$1 is the API Gateway region (e.g., us-east-1); \$1service\$1 is the name of the integrated AWS service (e.g., s3); and \$1subdomain\$1 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=\$1name\$1&\$1p1\$1=\$1v1\$1&p2=\$1v2\$1... query string. The ensuing \$1service\$1api\$1 refers to a supported action \$1name\$1 plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service\$1api 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}`.  
Type: String  
Required: No

## Response Syntax
<a name="API_PutIntegration_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "cacheKeyParameters": [ "string" ],
   "cacheNamespace": "string",
   "connectionId": "string",
   "connectionType": "string",
   "contentHandling": "string",
   "credentials": "string",
   "httpMethod": "string",
   "integrationResponses": { 
      "string" : { 
         "contentHandling": "string",
         "responseParameters": { 
            "string" : "string" 
         },
         "responseTemplates": { 
            "string" : "string" 
         },
         "selectionPattern": "string",
         "statusCode": "string"
      }
   },
   "integrationTarget": "string",
   "passthroughBehavior": "string",
   "requestParameters": { 
      "string" : "string" 
   },
   "requestTemplates": { 
      "string" : "string" 
   },
   "responseTransferMode": "string",
   "timeoutInMillis": number,
   "tlsConfig": { 
      "insecureSkipVerification": boolean
   },
   "type": "string",
   "uri": "string"
}
```

## Response Elements
<a name="API_PutIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [cacheKeyParameters](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-cacheKeyParameters"></a>
A list of request parameters whose values API Gateway caches. To be valid values for `cacheKeyParameters`, these parameters must also be specified for Method `requestParameters`.  
Type: Array of strings

 ** [cacheNamespace](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-cacheNamespace"></a>
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the `cacheNamespace`. You can specify the same `cacheNamespace` across resources to return the same cached data for requests to different resources.  
Type: String

 ** [connectionId](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-connectionId"></a>
The ID of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise.  
Type: String

 ** [connectionType](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-connectionType"></a>
The type of the network connection to the integration endpoint. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.  
Type: String  
Valid Values: `INTERNET | VPC_LINK` 

 ** [contentHandling](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-contentHandling"></a>
Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors:  
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass-through.  
Type: String  
Valid Values: `CONVERT_TO_BINARY | CONVERT_TO_TEXT` 

 ** [credentials](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-credentials"></a>
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.  
Type: String

 ** [httpMethod](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-httpMethod"></a>
Specifies the integration's HTTP method type. For the Type property, if you specify `MOCK`, this property is optional. For Lambda integrations, you must set the integration method to `POST`. For all other types, you must specify this property.  
Type: String

 ** [integrationResponses](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-integrationResponses"></a>
Specifies the integration's responses.  
Type: String to [IntegrationResponse](API_IntegrationResponse.md) object map

 ** [integrationTarget](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-integrationTarget"></a>
 The ALB or NLB listener to send the request to.   
Type: String

 ** [passthroughBehavior](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-passthroughBehavior"></a>
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.  
Type: String

 ** [requestParameters](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-requestParameters"></a>
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.  
Type: String to string map

 ** [requestTemplates](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-requestTemplates"></a>
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.  
Type: String to string map

 ** [responseTransferMode](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-responseTransferMode"></a>
 The response transfer mode of the integration.   
Type: String  
Valid Values: `BUFFERED | STREAM` 

 ** [timeoutInMillis](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-timeoutInMillis"></a>
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.  
Type: Integer

 ** [tlsConfig](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-tlsConfig"></a>
Specifies the TLS configuration for an integration.  
Type: [TlsConfig](API_TlsConfig.md) object

 ** [type](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-type"></a>
Specifies an API method integration type. The valid value is one of the following:  
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.  
Type: String  
Valid Values: `HTTP | AWS | MOCK | HTTP_PROXY | AWS_PROXY` 

 ** [uri](#API_PutIntegration_ResponseSyntax) **   <a name="apigw-PutIntegration-response-uri"></a>
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 standard integrations. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name. For `AWS` or `AWS_PROXY` integrations, the URI is of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}`. Here, \$1Region\$1 is the API Gateway region (e.g., us-east-1); \$1service\$1 is the name of the integrated AWS service (e.g., s3); and \$1subdomain\$1 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=\$1name\$1&\$1p1\$1=\$1v1\$1&p2=\$1v2\$1... query string. The ensuing \$1service\$1api\$1 refers to a supported action \$1name\$1 plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service\$1api 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}`   
Type: String

## Errors
<a name="API_PutIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_PutIntegration_Examples"></a>

### Integrate an HTTP GET method with the ListStreams action in Amazon Kinesis
<a name="API_PutIntegration_Example_1"></a>

This example illustrates one usage of PutIntegration.

#### Sample Request
<a name="API_PutIntegration_Example_1_Request"></a>

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

{
  "type" : "AWS",
  "httpMethod" : "POST",
  "uri" : "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams",
  "credentials" : "arn:aws:iam::123456789012:role/apigAwsProxyRole",
  "requestParameters" : {
    "integration.request.header.Content-Type": "'application/x-amz-json-1.1'"
  },
  "requestTemplates" : {
    "application/json": "{\n}"
  },
  "passthroughBehavior" : "WHEN_NO_MATCH"
}
```

#### Sample Response
<a name="API_PutIntegration_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      ...
    ],
    "self": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
    },
    "integration:delete": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
    },
    "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"
}
```

## See Also
<a name="API_PutIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/PutIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/PutIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/PutIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/PutIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/PutIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/PutIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/PutIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/PutIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/PutIntegration) 

# PutIntegrationResponse
<a name="API_PutIntegrationResponse"></a>

Represents a put integration.

## Request Syntax
<a name="API_PutIntegrationResponse_RequestSyntax"></a>

```
PUT /restapis/restapi_id/resources/resource_id/methods/http_method/integration/responses/status_code HTTP/1.1
Content-type: application/json

{
   "contentHandling": "string",
   "responseParameters": { 
      "string" : "string" 
   },
   "responseTemplates": { 
      "string" : "string" 
   },
   "selectionPattern": "string"
}
```

## URI Request Parameters
<a name="API_PutIntegrationResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_PutIntegrationResponse_RequestSyntax) **   <a name="apigw-PutIntegrationResponse-request-uri-httpMethod"></a>
Specifies a put integration response request's HTTP method.  
Required: Yes

 ** [resource\$1id](#API_PutIntegrationResponse_RequestSyntax) **   <a name="apigw-PutIntegrationResponse-request-uri-resourceId"></a>
Specifies a put integration response request's resource identifier.  
Required: Yes

 ** [restapi\$1id](#API_PutIntegrationResponse_RequestSyntax) **   <a name="apigw-PutIntegrationResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [status\$1code](#API_PutIntegrationResponse_RequestSyntax) **   <a name="apigw-PutIntegrationResponse-request-uri-statusCode"></a>
Specifies the status code that is used to map the integration response to an existing MethodResponse.  
Pattern: `[1-5]\d\d`   
Required: Yes

## Request Body
<a name="API_PutIntegrationResponse_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [contentHandling](#API_PutIntegrationResponse_RequestSyntax) **   <a name="apigw-PutIntegrationResponse-request-contentHandling"></a>
Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors:  
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.  
Type: String  
Valid Values: `CONVERT_TO_BINARY | CONVERT_TO_TEXT`   
Required: No

 ** [responseParameters](#API_PutIntegrationResponse_RequestSyntax) **   <a name="apigw-PutIntegrationResponse-request-responseParameters"></a>
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.  
Type: String to string map  
Required: No

 ** [responseTemplates](#API_PutIntegrationResponse_RequestSyntax) **   <a name="apigw-PutIntegrationResponse-request-responseTemplates"></a>
Specifies a put integration response's templates.  
Type: String to string map  
Required: No

 ** [selectionPattern](#API_PutIntegrationResponse_RequestSyntax) **   <a name="apigw-PutIntegrationResponse-request-selectionPattern"></a>
Specifies the selection pattern of a put integration response.  
Type: String  
Required: No

## Response Syntax
<a name="API_PutIntegrationResponse_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "contentHandling": "string",
   "responseParameters": { 
      "string" : "string" 
   },
   "responseTemplates": { 
      "string" : "string" 
   },
   "selectionPattern": "string",
   "statusCode": "string"
}
```

## Response Elements
<a name="API_PutIntegrationResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [contentHandling](#API_PutIntegrationResponse_ResponseSyntax) **   <a name="apigw-PutIntegrationResponse-response-contentHandling"></a>
Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors:  
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.  
Type: String  
Valid Values: `CONVERT_TO_BINARY | CONVERT_TO_TEXT` 

 ** [responseParameters](#API_PutIntegrationResponse_ResponseSyntax) **   <a name="apigw-PutIntegrationResponse-response-responseParameters"></a>
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.  
Type: String to string map

 ** [responseTemplates](#API_PutIntegrationResponse_ResponseSyntax) **   <a name="apigw-PutIntegrationResponse-response-responseTemplates"></a>
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.  
Type: String to string map

 ** [selectionPattern](#API_PutIntegrationResponse_ResponseSyntax) **   <a name="apigw-PutIntegrationResponse-response-selectionPattern"></a>
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.  
Type: String

 ** [statusCode](#API_PutIntegrationResponse_ResponseSyntax) **   <a name="apigw-PutIntegrationResponse-response-statusCode"></a>
Specifies the status code that is used to map the integration response to an existing MethodResponse.  
Type: String  
Pattern: `[1-5]\d\d` 

## Errors
<a name="API_PutIntegrationResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_PutIntegrationResponse_Examples"></a>

### Set up an integration response
<a name="API_PutIntegrationResponse_Example_1"></a>

This example illustrates one usage of PutIntegrationResponse.

#### Sample Request
<a name="API_PutIntegrationResponse_Example_1_Request"></a>

```
PUT /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: 20160602T233930Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160602/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "selectionPattern" : "2\d{2}",
  "responseParameters" : {
    "method.response.header.Content-Type" : "'application/json'"
  }
}
```

#### Sample Response
<a name="API_PutIntegrationResponse_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
      "name": "integrationresponse",
      "templated": true
    },
    "self": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
      "title": "200"
    },
    "integrationresponse:delete": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
    },
    "integrationresponse:update": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
    }
  },
  "responseParameters": {
    "method.response.header.Content-Type": "'application/json'"
  },
  "selectionPattern": "2\d{2}",
  "statusCode": "200"
}
```

## See Also
<a name="API_PutIntegrationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/PutIntegrationResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/PutIntegrationResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/PutIntegrationResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/PutIntegrationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/PutIntegrationResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/PutIntegrationResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/PutIntegrationResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/PutIntegrationResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutIntegrationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/PutIntegrationResponse) 

# PutMethod
<a name="API_PutMethod"></a>

Add a method to an existing Resource resource.

## Request Syntax
<a name="API_PutMethod_RequestSyntax"></a>

```
PUT /restapis/restapi_id/resources/resource_id/methods/http_method HTTP/1.1
Content-type: application/json

{
   "apiKeyRequired": boolean,
   "authorizationScopes": [ "string" ],
   "authorizationType": "string",
   "authorizerId": "string",
   "operationName": "string",
   "requestModels": { 
      "string" : "string" 
   },
   "requestParameters": { 
      "string" : boolean 
   },
   "requestValidatorId": "string"
}
```

## URI Request Parameters
<a name="API_PutMethod_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_PutMethod_RequestSyntax) **   <a name="apigw-PutMethod-request-uri-httpMethod"></a>
Specifies the method request's HTTP method type.  
Required: Yes

 ** [resource\$1id](#API_PutMethod_RequestSyntax) **   <a name="apigw-PutMethod-request-uri-resourceId"></a>
The Resource identifier for the new Method resource.  
Required: Yes

 ** [restapi\$1id](#API_PutMethod_RequestSyntax) **   <a name="apigw-PutMethod-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_PutMethod_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [apiKeyRequired](#API_PutMethod_RequestSyntax) **   <a name="apigw-PutMethod-request-apiKeyRequired"></a>
Specifies whether the method required a valid ApiKey.  
Type: Boolean  
Required: No

 ** [authorizationScopes](#API_PutMethod_RequestSyntax) **   <a name="apigw-PutMethod-request-authorizationScopes"></a>
A list of authorization scopes configured on the method. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.  
Type: Array of strings  
Required: No

 ** [authorizationType](#API_PutMethod_RequestSyntax) **   <a name="apigw-PutMethod-request-authorizationType"></a>
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.  
Type: String  
Required: Yes

 ** [authorizerId](#API_PutMethod_RequestSyntax) **   <a name="apigw-PutMethod-request-authorizerId"></a>
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO\$1USER\$1POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.  
Type: String  
Required: No

 ** [operationName](#API_PutMethod_RequestSyntax) **   <a name="apigw-PutMethod-request-operationName"></a>
A human-friendly operation identifier for the method. For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example.  
Type: String  
Required: No

 ** [requestModels](#API_PutMethod_RequestSyntax) **   <a name="apigw-PutMethod-request-requestModels"></a>
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.  
Type: String to string map  
Required: No

 ** [requestParameters](#API_PutMethod_RequestSyntax) **   <a name="apigw-PutMethod-request-requestParameters"></a>
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.  
Type: String to boolean map  
Required: No

 ** [requestValidatorId](#API_PutMethod_RequestSyntax) **   <a name="apigw-PutMethod-request-requestValidatorId"></a>
The identifier of a RequestValidator for validating the method request.  
Type: String  
Required: No

## Response Syntax
<a name="API_PutMethod_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "apiKeyRequired": boolean,
   "authorizationScopes": [ "string" ],
   "authorizationType": "string",
   "authorizerId": "string",
   "httpMethod": "string",
   "methodIntegration": { 
      "cacheKeyParameters": [ "string" ],
      "cacheNamespace": "string",
      "connectionId": "string",
      "connectionType": "string",
      "contentHandling": "string",
      "credentials": "string",
      "httpMethod": "string",
      "integrationResponses": { 
         "string" : { 
            "contentHandling": "string",
            "responseParameters": { 
               "string" : "string" 
            },
            "responseTemplates": { 
               "string" : "string" 
            },
            "selectionPattern": "string",
            "statusCode": "string"
         }
      },
      "integrationTarget": "string",
      "passthroughBehavior": "string",
      "requestParameters": { 
         "string" : "string" 
      },
      "requestTemplates": { 
         "string" : "string" 
      },
      "responseTransferMode": "string",
      "timeoutInMillis": number,
      "tlsConfig": { 
         "insecureSkipVerification": boolean
      },
      "type": "string",
      "uri": "string"
   },
   "methodResponses": { 
      "string" : { 
         "responseModels": { 
            "string" : "string" 
         },
         "responseParameters": { 
            "string" : boolean 
         },
         "statusCode": "string"
      }
   },
   "operationName": "string",
   "requestModels": { 
      "string" : "string" 
   },
   "requestParameters": { 
      "string" : boolean 
   },
   "requestValidatorId": "string"
}
```

## Response Elements
<a name="API_PutMethod_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [apiKeyRequired](#API_PutMethod_ResponseSyntax) **   <a name="apigw-PutMethod-response-apiKeyRequired"></a>
A boolean flag specifying whether a valid ApiKey is required to invoke this method.  
Type: Boolean

 ** [authorizationScopes](#API_PutMethod_ResponseSyntax) **   <a name="apigw-PutMethod-response-authorizationScopes"></a>
A list of authorization scopes configured on the method. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.  
Type: Array of strings

 ** [authorizationType](#API_PutMethod_ResponseSyntax) **   <a name="apigw-PutMethod-response-authorizationType"></a>
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.  
Type: String

 ** [authorizerId](#API_PutMethod_ResponseSyntax) **   <a name="apigw-PutMethod-response-authorizerId"></a>
The identifier of an authorizer to use on this method. The method's authorization type must be `CUSTOM` or `COGNITO_USER_POOLS`.  
Type: String

 ** [httpMethod](#API_PutMethod_ResponseSyntax) **   <a name="apigw-PutMethod-response-httpMethod"></a>
The method's HTTP verb.  
Type: String

 ** [methodIntegration](#API_PutMethod_ResponseSyntax) **   <a name="apigw-PutMethod-response-methodIntegration"></a>
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.  
Type: [Integration](API_Integration.md) object

 ** [methodResponses](#API_PutMethod_ResponseSyntax) **   <a name="apigw-PutMethod-response-methodResponses"></a>
Gets a method response associated with a given HTTP status code.   
Type: String to [MethodResponse](API_MethodResponse.md) object map

 ** [operationName](#API_PutMethod_ResponseSyntax) **   <a name="apigw-PutMethod-response-operationName"></a>
A human-friendly operation identifier for the method. For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example.  
Type: String

 ** [requestModels](#API_PutMethod_ResponseSyntax) **   <a name="apigw-PutMethod-response-requestModels"></a>
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).  
Type: String to string map

 ** [requestParameters](#API_PutMethod_ResponseSyntax) **   <a name="apigw-PutMethod-response-requestParameters"></a>
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.  
Type: String to boolean map

 ** [requestValidatorId](#API_PutMethod_ResponseSyntax) **   <a name="apigw-PutMethod-response-requestValidatorId"></a>
The identifier of a RequestValidator for request validation.  
Type: String

## Errors
<a name="API_PutMethod_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_PutMethod_Examples"></a>

### Create a GET method on an API's root resource
<a name="API_PutMethod_Example_1"></a>

This example illustrates one usage of PutMethod.

#### Sample Request
<a name="API_PutMethod_Example_1_Request"></a>

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

{
    "authorizationType" : "NONE"
}
```

#### Sample Response
<a name="API_PutMethod_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      ...
    ],
    "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: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"
}
```

## See Also
<a name="API_PutMethod_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/PutMethod) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/PutMethod) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/PutMethod) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/PutMethod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/PutMethod) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/PutMethod) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/PutMethod) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/PutMethod) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutMethod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/PutMethod) 

# PutMethodResponse
<a name="API_PutMethodResponse"></a>

Adds a MethodResponse to an existing Method resource.

## Request Syntax
<a name="API_PutMethodResponse_RequestSyntax"></a>

```
PUT /restapis/restapi_id/resources/resource_id/methods/http_method/responses/status_code HTTP/1.1
Content-type: application/json

{
   "responseModels": { 
      "string" : "string" 
   },
   "responseParameters": { 
      "string" : boolean 
   }
}
```

## URI Request Parameters
<a name="API_PutMethodResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_PutMethodResponse_RequestSyntax) **   <a name="apigw-PutMethodResponse-request-uri-httpMethod"></a>
The HTTP verb of the Method resource.  
Required: Yes

 ** [resource\$1id](#API_PutMethodResponse_RequestSyntax) **   <a name="apigw-PutMethodResponse-request-uri-resourceId"></a>
The Resource identifier for the Method resource.  
Required: Yes

 ** [restapi\$1id](#API_PutMethodResponse_RequestSyntax) **   <a name="apigw-PutMethodResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [status\$1code](#API_PutMethodResponse_RequestSyntax) **   <a name="apigw-PutMethodResponse-request-uri-statusCode"></a>
The method response's status code.  
Pattern: `[1-5]\d\d`   
Required: Yes

## Request Body
<a name="API_PutMethodResponse_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [responseModels](#API_PutMethodResponse_RequestSyntax) **   <a name="apigw-PutMethodResponse-request-responseModels"></a>
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.  
Type: String to string map  
Required: No

 ** [responseParameters](#API_PutMethodResponse_RequestSyntax) **   <a name="apigw-PutMethodResponse-request-responseParameters"></a>
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.)  
Type: String to boolean map  
Required: No

## Response Syntax
<a name="API_PutMethodResponse_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "responseModels": { 
      "string" : "string" 
   },
   "responseParameters": { 
      "string" : boolean 
   },
   "statusCode": "string"
}
```

## Response Elements
<a name="API_PutMethodResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [responseModels](#API_PutMethodResponse_ResponseSyntax) **   <a name="apigw-PutMethodResponse-response-responseModels"></a>
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.  
Type: String to string map

 ** [responseParameters](#API_PutMethodResponse_ResponseSyntax) **   <a name="apigw-PutMethodResponse-response-responseParameters"></a>
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.)  
Type: String to boolean map

 ** [statusCode](#API_PutMethodResponse_ResponseSyntax) **   <a name="apigw-PutMethodResponse-response-statusCode"></a>
The method response's status code.  
Type: String  
Pattern: `[1-5]\d\d` 

## Errors
<a name="API_PutMethodResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_PutMethodResponse_Examples"></a>

### Set up a method response with an optional Content-Type header
<a name="API_PutMethodResponse_Example_1"></a>

This example illustrates one usage of PutMethodResponse.

#### Sample Request
<a name="API_PutMethodResponse_Example_1_Request"></a>

```
PUT /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: 20160603T004142Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
    "responseParameters" : {
        "method.response.header.Content-Type" : false
    },
    "responseModels" : {
        "application/json" : "Empty"
    }
}
```

#### Sample Response
<a name="API_PutMethodResponse_Example_1_Response"></a>

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

## See Also
<a name="API_PutMethodResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/PutMethodResponse) 

# PutRestApi
<a name="API_PutRestApi"></a>

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.

## Request Syntax
<a name="API_PutRestApi_RequestSyntax"></a>

```
PUT /restapis/restapi_id?parameters&failonwarnings=failOnWarnings&mode=mode HTTP/1.1

body
```

## URI Request Parameters
<a name="API_PutRestApi_RequestParameters"></a>

The request uses the following URI parameters.

 ** [failOnWarnings](#API_PutRestApi_RequestSyntax) **   <a name="apigw-PutRestApi-request-uri-failOnWarnings"></a>
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`.

 ** [mode](#API_PutRestApi_RequestSyntax) **   <a name="apigw-PutRestApi-request-uri-mode"></a>
The `mode` query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".  
Valid Values: `merge | overwrite` 

 ** [parameters](#API_PutRestApi_RequestSyntax) **   <a name="apigw-PutRestApi-request-uri-parameters"></a>
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'`.

 ** [restapi\$1id](#API_PutRestApi_RequestSyntax) **   <a name="apigw-PutRestApi-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_PutRestApi_RequestBody"></a>

The request accepts the following binary data.

 ** [body](#API_PutRestApi_RequestSyntax) **   <a name="apigw-PutRestApi-request-body"></a>
The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.  
Required: Yes

## Response Syntax
<a name="API_PutRestApi_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "apiKeySource": "string",
   "apiStatus": "string",
   "apiStatusMessage": "string",
   "binaryMediaTypes": [ "string" ],
   "createdDate": number,
   "description": "string",
   "disableExecuteApiEndpoint": boolean,
   "endpointAccessMode": "string",
   "endpointConfiguration": { 
      "ipAddressType": "string",
      "types": [ "string" ],
      "vpcEndpointIds": [ "string" ]
   },
   "id": "string",
   "minimumCompressionSize": number,
   "name": "string",
   "policy": "string",
   "rootResourceId": "string",
   "securityPolicy": "string",
   "tags": { 
      "string" : "string" 
   },
   "version": "string",
   "warnings": [ "string" ]
}
```

## Response Elements
<a name="API_PutRestApi_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [apiKeySource](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-apiKeySource"></a>
The source of the API key for metering requests according to a usage plan. Valid values are: >`HEADER` to read the API key from the `X-API-Key` header of a request. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer.  
Type: String  
Valid Values: `HEADER | AUTHORIZER` 

 ** [apiStatus](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-apiStatus"></a>
The ApiStatus of the RestApi.   
Type: String  
Valid Values: `UPDATING | AVAILABLE | PENDING | FAILED` 

 ** [apiStatusMessage](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-apiStatusMessage"></a>
 The status message of the RestApi. When the status message is `UPDATING` you can still invoke it.   
Type: String

 ** [binaryMediaTypes](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-binaryMediaTypes"></a>
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.  
Type: Array of strings

 ** [createdDate](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-createdDate"></a>
The timestamp when the API was created.  
Type: Timestamp

 ** [description](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-description"></a>
The API's description.  
Type: String

 ** [disableExecuteApiEndpoint](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-disableExecuteApiEndpoint"></a>
Specifies whether clients can invoke your API by using the default `execute-api` endpoint. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.  
Type: Boolean

 ** [endpointAccessMode](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-endpointAccessMode"></a>
 The endpoint access mode of the RestApi.   
Type: String  
Valid Values: `BASIC | STRICT` 

 ** [endpointConfiguration](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-endpointConfiguration"></a>
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.   
Type: [EndpointConfiguration](API_EndpointConfiguration.md) object

 ** [id](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-id"></a>
The API's identifier. This identifier is unique across all of your APIs in API Gateway.  
Type: String

 ** [minimumCompressionSize](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-minimumCompressionSize"></a>
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.  
Type: Integer

 ** [name](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-name"></a>
The API's name.  
Type: String

 ** [policy](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-policy"></a>
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.  
Type: String

 ** [rootResourceId](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-rootResourceId"></a>
The API's root resource ID.  
Type: String

 ** [securityPolicy](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-securityPolicy"></a>
 The Transport Layer Security (TLS) version \$1 cipher suite for this RestApi.   
Type: String  
Valid Values: `TLS_1_0 | TLS_1_2 | SecurityPolicy_TLS13_1_3_2025_09 | SecurityPolicy_TLS13_1_3_FIPS_2025_09 | SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_PQ_2025_09 | SecurityPolicy_TLS13_1_2_2021_06 | SecurityPolicy_TLS13_2025_EDGE | SecurityPolicy_TLS12_PFS_2025_EDGE | SecurityPolicy_TLS12_2018_EDGE` 

 ** [tags](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [version](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-version"></a>
A version identifier for the API.  
Type: String

 ** [warnings](#API_PutRestApi_ResponseSyntax) **   <a name="apigw-PutRestApi-response-warnings"></a>
The warning messages reported when `failonwarnings` is turned on during API import.  
Type: Array of strings

## Errors
<a name="API_PutRestApi_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_PutRestApi_Examples"></a>

### Merge a supplied OpenAPI API definition with an existing API
<a name="API_PutRestApi_Example_1"></a>

This example illustrates one usage of PutRestApi.

#### Sample Request
<a name="API_PutRestApi_Example_1_Request"></a>

```
PUT /restapis/wn611yeyp3?mode=merge HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160607T154932Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "swagger": "2.0",
  "info": {
    "version": "2016-06-07T15:48:21Z",
    "title": "HelloWorld"
  },
  "host": "vys2gggws7.execute-api.us-east-1.amazonaws.com",
  "basepath": "/test",
  "schemes": [
    "https"
  ],
  "paths": {
    "/gello": {
      "get": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "200 response",
            "schema": {
              "$ref": "#/definitions/Empty"
            }
          }
        },
        "x-amazon-apigateway-integration": {
          "responses": {
            "default": {
              "statusCode": "200"
            }
          },
          "requestTemplates": {
            "application/json": "{}"
          },
          "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789012:function:GetHelloWorld/invocations",
          "passthroughBehavior": "when_no_match",
          "httpMethod": "POST",
          "type": "aws"
        }
      },
      "post": {
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "200 response",
            "schema": {
              "$ref": "#/definitions/Empty"
            }
          }
        },
        "x-amazon-apigateway-integration": {
          "responses": {
            "default": {
              "statusCode": "200"
            }
          },
          "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789012:function:GetHelloWorldName/invocations",
          "passthroughBehavior": "when_no_match",
          "httpMethod": "POST",
          "type": "aws"
        }
      }
    },
    "/hello": {
      "get": {
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "200 response",
            "schema": {
              "$ref": "#/definitions/Empty"
            },
            "headers": {
              "Access-Control-Allow-Origin": {
                "type": "string"
              }
            }
          }
        },
        "x-amazon-apigateway-integration": {
          "responses": {
            "default": {
              "statusCode": "200",
              "responseParameters": {
                "method.response.header.Access-Control-Allow-Origin": "'*'"
              }
            }
          },
          "uri": "https://example.com",
          "passthroughBehavior": "when_no_match",
          "httpMethod": "GET",
          "type": "http"
        }
      },
      "options": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "200 response",
            "schema": {
              "$ref": "#/definitions/Empty"
            },
            "headers": {
              "Access-Control-Allow-Origin": {
                "type": "string"
              },
              "Access-Control-Allow-Methods": {
                "type": "string"
              },
              "Access-Control-Allow-Headers": {
                "type": "string"
              }
            }
          }
        },
        "x-amazon-apigateway-integration": {
          "responses": {
            "default": {
              "statusCode": "200",
              "responseParameters": {
                "method.response.header.Access-Control-Allow-Methods": "'GET,OPTIONS'",
                "method.response.header.Access-Control-Allow-Headers": "'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token'",
                "method.response.header.Access-Control-Allow-Origin": "'*'"
              }
            }
          },
          "requestTemplates": {
            "application/json": "{\"statusCode\": 200}"
          },
          "passthroughBehavior": "when_no_match",
          "type": "mock"
        }
      }
    }
  },
  "definitions": {
    "Empty": {
      "type": "object"
    }
  }
}
```

#### Sample Response
<a name="API_PutRestApi_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-authorizer-{rel}.html",
        "name": "authorizer",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-deployment-{rel}.html",
        "name": "deployment",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-model-{rel}.html",
        "name": "model",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-resource-{rel}.html",
        "name": "resource",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-restapi-{rel}.html",
        "name": "restapi",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-stage-{rel}.html",
        "name": "stage",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis/wn611yeyp3"
    },
    "authorizer:by-id": {
      "href": "/restapis/wn611yeyp3/authorizers/{authorizer_id}",
      "templated": true
    },
    "authorizer:create": {
      "href": "/restapis/wn611yeyp3/authorizers"
    },
    "deployment:by-id": {
      "href": "/restapis/wn611yeyp3/deployments/{deployment_id}{?embed}",
      "templated": true
    },
    "deployment:create": {
      "href": "/restapis/wn611yeyp3/deployments"
    },
    "model:by-name": {
      "href": "/restapis/wn611yeyp3/models/{model_name}?flatten=false",
      "templated": true
    },
    "model:create": {
      "href": "/restapis/wn611yeyp3/models"
    },
    "resource:by-id": {
      "href": "/restapis/wn611yeyp3/resources/{resource_id}{?embed}",
      "templated": true
    },
    "resource:create": {
      "href": "/restapis/wn611yeyp3/resources/s3dmsjgijc"
    },
    "restapi:authorizers": {
      "href": "/restapis/wn611yeyp3/authorizers"
    },
    "restapi:delete": {
      "href": "/restapis/wn611yeyp3"
    },
    "restapi:deployments": {
      "href": "/restapis/wn611yeyp3/deployments{?limit}",
      "templated": true
    },
    "restapi:models": {
      "href": "/restapis/wn611yeyp3/models"
    },
    "restapi:resources": {
      "href": "/restapis/wn611yeyp3/resources{?limit,embed}",
      "templated": true
    },
    "restapi:stages": {
      "href": "/restapis/wn611yeyp3/stages{?deployment_id}",
      "templated": true
    },
    "restapi:update": {
      "href": "/restapis/wn611yeyp3"
    },
    "stage:by-name": {
      "href": "/restapis/wn611yeyp3/stages/{stage_name}",
      "templated": true
    },
    "stage:create": {
      "href": "/restapis/wn611yeyp3/stages"
    }
  },
  "createdDate": "2016-06-06T23:49:37Z",
  "id": "wn611yeyp3",
  "name": "HelloWorld"
}
```

## See Also
<a name="API_PutRestApi_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/PutRestApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/PutRestApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/PutRestApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/PutRestApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/PutRestApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/PutRestApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/PutRestApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/PutRestApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutRestApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/PutRestApi) 

# RejectDomainNameAccessAssociation
<a name="API_RejectDomainNameAccessAssociation"></a>

Rejects a domain name access association with a private custom domain name.

To reject a domain name access association with an access association source in another AWS account, use this operation. To remove a domain name access association with an access association source in your own account, use the DeleteDomainNameAccessAssociation operation.

## Request Syntax
<a name="API_RejectDomainNameAccessAssociation_RequestSyntax"></a>

```
POST /rejectdomainnameaccessassociations?domainNameAccessAssociationArn=domainNameAccessAssociationArn&domainNameArn=domainNameArn HTTP/1.1
```

## URI Request Parameters
<a name="API_RejectDomainNameAccessAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainNameAccessAssociationArn](#API_RejectDomainNameAccessAssociation_RequestSyntax) **   <a name="apigw-RejectDomainNameAccessAssociation-request-uri-domainNameAccessAssociationArn"></a>
The ARN of the domain name access association resource.   
Required: Yes

 ** [domainNameArn](#API_RejectDomainNameAccessAssociation_RequestSyntax) **   <a name="apigw-RejectDomainNameAccessAssociation-request-uri-domainNameArn"></a>
 The ARN of the domain name.   
Required: Yes

## Request Body
<a name="API_RejectDomainNameAccessAssociation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_RejectDomainNameAccessAssociation_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_RejectDomainNameAccessAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_RejectDomainNameAccessAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_RejectDomainNameAccessAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/RejectDomainNameAccessAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/RejectDomainNameAccessAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/RejectDomainNameAccessAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/RejectDomainNameAccessAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/RejectDomainNameAccessAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/RejectDomainNameAccessAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/RejectDomainNameAccessAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/RejectDomainNameAccessAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/RejectDomainNameAccessAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/RejectDomainNameAccessAssociation) 

# TagResource
<a name="API_TagResource"></a>

Adds or updates a tag on a given resource.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
PUT /tags/resource_arn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resource\$1arn](#API_TagResource_RequestSyntax) **   <a name="apigw-TagResource-request-uri-resourceArn"></a>
The ARN of a resource that can be tagged.  
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="apigw-TagResource-request-tags"></a>
The key-value map of strings. The valid character set is [a-zA-Z\$1-=.\$1:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.  
Type: String to string map  
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/TagResource) 

# TestInvokeAuthorizer
<a name="API_TestInvokeAuthorizer"></a>

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

## Request Syntax
<a name="API_TestInvokeAuthorizer_RequestSyntax"></a>

```
POST /restapis/restapi_id/authorizers/authorizer_id HTTP/1.1
Content-type: application/json

{
   "additionalContext": { 
      "string" : "string" 
   },
   "body": "string",
   "headers": { 
      "string" : "string" 
   },
   "multiValueHeaders": { 
      "string" : [ "string" ]
   },
   "pathWithQueryString": "string",
   "stageVariables": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TestInvokeAuthorizer_RequestParameters"></a>

The request uses the following URI parameters.

 ** [authorizer\$1id](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-uri-authorizerId"></a>
Specifies a test invoke authorizer request's Authorizer ID.  
Required: Yes

 ** [restapi\$1id](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_TestInvokeAuthorizer_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [additionalContext](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-additionalContext"></a>
A key-value map of additional context variables.  
Type: String to string map  
Required: No

 ** [body](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-body"></a>
The simulated request body of an incoming invocation request.  
Type: String  
Required: No

 ** [headers](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-headers"></a>
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.  
Type: String to string map  
Required: No

 ** [multiValueHeaders](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-multiValueHeaders"></a>
The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.  
Type: String to array of strings map  
Required: No

 ** [pathWithQueryString](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-pathWithQueryString"></a>
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.  
Type: String  
Required: No

 ** [stageVariables](#API_TestInvokeAuthorizer_RequestSyntax) **   <a name="apigw-TestInvokeAuthorizer-request-stageVariables"></a>
A key-value map of stage variables to simulate an invocation on a deployed Stage.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_TestInvokeAuthorizer_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "authorization": { 
      "string" : [ "string" ]
   },
   "claims": { 
      "string" : "string" 
   },
   "clientStatus": number,
   "latency": number,
   "log": "string",
   "policy": "string",
   "principalId": "string"
}
```

## Response Elements
<a name="API_TestInvokeAuthorizer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [authorization](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-authorization"></a>
The authorization response.  
Type: String to array of strings map

 ** [claims](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-claims"></a>
The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.  
Type: String to string map

 ** [clientStatus](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-clientStatus"></a>
The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.  
Type: Integer

 ** [latency](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-latency"></a>
The execution latency, in ms, of the test authorizer request.  
Type: Long

 ** [log](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-log"></a>
The API Gateway execution log for the test authorizer request.  
Type: String

 ** [policy](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-policy"></a>
The JSON policy document returned by the Authorizer  
Type: String

 ** [principalId](#API_TestInvokeAuthorizer_ResponseSyntax) **   <a name="apigw-TestInvokeAuthorizer-response-principalId"></a>
The principal identity returned by the Authorizer  
Type: String

## Errors
<a name="API_TestInvokeAuthorizer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_TestInvokeAuthorizer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/TestInvokeAuthorizer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/TestInvokeAuthorizer) 

# TestInvokeMethod
<a name="API_TestInvokeMethod"></a>

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

## Request Syntax
<a name="API_TestInvokeMethod_RequestSyntax"></a>

```
POST /restapis/restapi_id/resources/resource_id/methods/http_method HTTP/1.1
Content-type: application/json

{
   "body": "string",
   "clientCertificateId": "string",
   "headers": { 
      "string" : "string" 
   },
   "multiValueHeaders": { 
      "string" : [ "string" ]
   },
   "pathWithQueryString": "string",
   "stageVariables": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TestInvokeMethod_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_TestInvokeMethod_RequestSyntax) **   <a name="apigw-TestInvokeMethod-request-uri-httpMethod"></a>
Specifies a test invoke method request's HTTP method.  
Required: Yes

 ** [resource\$1id](#API_TestInvokeMethod_RequestSyntax) **   <a name="apigw-TestInvokeMethod-request-uri-resourceId"></a>
Specifies a test invoke method request's resource ID.  
Required: Yes

 ** [restapi\$1id](#API_TestInvokeMethod_RequestSyntax) **   <a name="apigw-TestInvokeMethod-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_TestInvokeMethod_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [body](#API_TestInvokeMethod_RequestSyntax) **   <a name="apigw-TestInvokeMethod-request-body"></a>
The simulated request body of an incoming invocation request.  
Type: String  
Required: No

 ** [clientCertificateId](#API_TestInvokeMethod_RequestSyntax) **   <a name="apigw-TestInvokeMethod-request-clientCertificateId"></a>
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.  
Type: String  
Required: No

 ** [headers](#API_TestInvokeMethod_RequestSyntax) **   <a name="apigw-TestInvokeMethod-request-headers"></a>
A key-value map of headers to simulate an incoming invocation request.  
Type: String to string map  
Required: No

 ** [multiValueHeaders](#API_TestInvokeMethod_RequestSyntax) **   <a name="apigw-TestInvokeMethod-request-multiValueHeaders"></a>
The headers as a map from string to list of values to simulate an incoming invocation request.  
Type: String to array of strings map  
Required: No

 ** [pathWithQueryString](#API_TestInvokeMethod_RequestSyntax) **   <a name="apigw-TestInvokeMethod-request-pathWithQueryString"></a>
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.  
Type: String  
Required: No

 ** [stageVariables](#API_TestInvokeMethod_RequestSyntax) **   <a name="apigw-TestInvokeMethod-request-stageVariables"></a>
A key-value map of stage variables to simulate an invocation on a deployed Stage.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_TestInvokeMethod_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "body": "string",
   "headers": { 
      "string" : "string" 
   },
   "latency": number,
   "log": "string",
   "multiValueHeaders": { 
      "string" : [ "string" ]
   },
   "status": number
}
```

## Response Elements
<a name="API_TestInvokeMethod_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [body](#API_TestInvokeMethod_ResponseSyntax) **   <a name="apigw-TestInvokeMethod-response-body"></a>
The body of the HTTP response.  
Type: String

 ** [headers](#API_TestInvokeMethod_ResponseSyntax) **   <a name="apigw-TestInvokeMethod-response-headers"></a>
The headers of the HTTP response.  
Type: String to string map

 ** [latency](#API_TestInvokeMethod_ResponseSyntax) **   <a name="apigw-TestInvokeMethod-response-latency"></a>
The execution latency, in ms, of the test invoke request.  
Type: Long

 ** [log](#API_TestInvokeMethod_ResponseSyntax) **   <a name="apigw-TestInvokeMethod-response-log"></a>
The API Gateway execution log for the test invoke request.  
Type: String

 ** [multiValueHeaders](#API_TestInvokeMethod_ResponseSyntax) **   <a name="apigw-TestInvokeMethod-response-multiValueHeaders"></a>
The headers of the HTTP response as a map from string to list of values.  
Type: String to array of strings map

 ** [status](#API_TestInvokeMethod_ResponseSyntax) **   <a name="apigw-TestInvokeMethod-response-status"></a>
The HTTP status code.  
Type: Integer

## Errors
<a name="API_TestInvokeMethod_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_TestInvokeMethod_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/TestInvokeMethod) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/TestInvokeMethod) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/TestInvokeMethod) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/TestInvokeMethod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/TestInvokeMethod) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/TestInvokeMethod) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/TestInvokeMethod) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/TestInvokeMethod) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/TestInvokeMethod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/TestInvokeMethod) 

# UntagResource
<a name="API_UntagResource"></a>

Removes a tag from a given resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resource_arn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resource\$1arn](#API_UntagResource_RequestSyntax) **   <a name="apigw-UntagResource-request-uri-resourceArn"></a>
The ARN of a resource that can be tagged.  
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="apigw-UntagResource-request-uri-tagKeys"></a>
The Tag keys to delete.  
Required: Yes

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UntagResource) 

# UpdateAccount
<a name="API_UpdateAccount"></a>

Changes information about the current Account resource.

## Request Syntax
<a name="API_UpdateAccount_RequestSyntax"></a>

```
PATCH /account HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateAccount_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateAccount_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateAccount_RequestSyntax) **   <a name="apigw-UpdateAccount-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateAccount_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "apiKeyVersion": "string",
   "cloudwatchRoleArn": "string",
   "features": [ "string" ],
   "throttleSettings": { 
      "burstLimit": number,
      "rateLimit": number
   }
}
```

## Response Elements
<a name="API_UpdateAccount_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [apiKeyVersion](#API_UpdateAccount_ResponseSyntax) **   <a name="apigw-UpdateAccount-response-apiKeyVersion"></a>
The version of the API keys used for the account.  
Type: String

 ** [cloudwatchRoleArn](#API_UpdateAccount_ResponseSyntax) **   <a name="apigw-UpdateAccount-response-cloudwatchRoleArn"></a>
The ARN of an Amazon CloudWatch role for the current Account.   
Type: String

 ** [features](#API_UpdateAccount_ResponseSyntax) **   <a name="apigw-UpdateAccount-response-features"></a>
A list of features supported for the account. When usage plans are enabled, the features list will include an entry of `"UsagePlans"`.  
Type: Array of strings

 ** [throttleSettings](#API_UpdateAccount_ResponseSyntax) **   <a name="apigw-UpdateAccount-response-throttleSettings"></a>
Specifies the API request limits configured for the current Account.  
Type: [ThrottleSettings](API_ThrottleSettings.md) object

## Errors
<a name="API_UpdateAccount_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateAccount_Examples"></a>

### Update an Account's CloudWatch role
<a name="API_UpdateAccount_Example_1"></a>

The following example updates an account's CloudWatch role ARN by replacing the existing one with a new CloudWatch role ARN.

If you specify an invalid role, i.e., a role that does not permit API Gateway to invoke CloudWatch logs, you will receive an error response. If you attempt to replace the throttleSettings, in part or as a whole, you will receive 400 Bad Request response with an error message stating that /throttleSettings value cannot be changed this way, but the /cloudwatchRoleArn value can.

#### Sample Request
<a name="API_UpdateAccount_Example_1_Request"></a>

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

{
    "patchOperations" : [{
        "op" : "replace",
        "path" : "/cloudwatchRoleArn",
        "value" : "arn:aws:iam::123456789012:role/apigAwsProxyRole"
    }]
}
```

#### Sample Response
<a name="API_UpdateAccount_Example_1_Response"></a>

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

## See Also
<a name="API_UpdateAccount_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateAccount) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateAccount) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateAccount) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateAccount) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateAccount) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateAccount) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateAccount) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateAccount) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateAccount) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateAccount) 

# UpdateApiKey
<a name="API_UpdateApiKey"></a>

Changes information about an ApiKey resource.

## Request Syntax
<a name="API_UpdateApiKey_RequestSyntax"></a>

```
PATCH /apikeys/api_Key HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateApiKey_RequestParameters"></a>

The request uses the following URI parameters.

 ** [api\$1Key](#API_UpdateApiKey_RequestSyntax) **   <a name="apigw-UpdateApiKey-request-uri-apiKey"></a>
The identifier of the ApiKey resource to be updated.  
Required: Yes

## Request Body
<a name="API_UpdateApiKey_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateApiKey_RequestSyntax) **   <a name="apigw-UpdateApiKey-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateApiKey_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdDate": number,
   "customerId": "string",
   "description": "string",
   "enabled": boolean,
   "id": "string",
   "lastUpdatedDate": number,
   "name": "string",
   "stageKeys": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "value": "string"
}
```

## Response Elements
<a name="API_UpdateApiKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdDate](#API_UpdateApiKey_ResponseSyntax) **   <a name="apigw-UpdateApiKey-response-createdDate"></a>
The timestamp when the API Key was created.  
Type: Timestamp

 ** [customerId](#API_UpdateApiKey_ResponseSyntax) **   <a name="apigw-UpdateApiKey-response-customerId"></a>
An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.  
Type: String

 ** [description](#API_UpdateApiKey_ResponseSyntax) **   <a name="apigw-UpdateApiKey-response-description"></a>
The description of the API Key.  
Type: String

 ** [enabled](#API_UpdateApiKey_ResponseSyntax) **   <a name="apigw-UpdateApiKey-response-enabled"></a>
Specifies whether the API Key can be used by callers.  
Type: Boolean

 ** [id](#API_UpdateApiKey_ResponseSyntax) **   <a name="apigw-UpdateApiKey-response-id"></a>
The identifier of the API Key.  
Type: String

 ** [lastUpdatedDate](#API_UpdateApiKey_ResponseSyntax) **   <a name="apigw-UpdateApiKey-response-lastUpdatedDate"></a>
The timestamp when the API Key was last updated.  
Type: Timestamp

 ** [name](#API_UpdateApiKey_ResponseSyntax) **   <a name="apigw-UpdateApiKey-response-name"></a>
The name of the API Key.  
Type: String

 ** [stageKeys](#API_UpdateApiKey_ResponseSyntax) **   <a name="apigw-UpdateApiKey-response-stageKeys"></a>
A list of Stage resources that are associated with the ApiKey resource.  
Type: Array of strings

 ** [tags](#API_UpdateApiKey_ResponseSyntax) **   <a name="apigw-UpdateApiKey-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [value](#API_UpdateApiKey_ResponseSyntax) **   <a name="apigw-UpdateApiKey-response-value"></a>
The value of the API Key.  
Type: String

## Errors
<a name="API_UpdateApiKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_UpdateApiKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateApiKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateApiKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateApiKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateApiKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateApiKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateApiKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateApiKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateApiKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateApiKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateApiKey) 

# UpdateAuthorizer
<a name="API_UpdateAuthorizer"></a>

Updates an existing Authorizer resource.

## Request Syntax
<a name="API_UpdateAuthorizer_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/authorizers/authorizer_id HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateAuthorizer_RequestParameters"></a>

The request uses the following URI parameters.

 ** [authorizer\$1id](#API_UpdateAuthorizer_RequestSyntax) **   <a name="apigw-UpdateAuthorizer-request-uri-authorizerId"></a>
The identifier of the Authorizer resource.  
Required: Yes

 ** [restapi\$1id](#API_UpdateAuthorizer_RequestSyntax) **   <a name="apigw-UpdateAuthorizer-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_UpdateAuthorizer_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateAuthorizer_RequestSyntax) **   <a name="apigw-UpdateAuthorizer-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateAuthorizer_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "authorizerCredentials": "string",
   "authorizerResultTtlInSeconds": number,
   "authorizerUri": "string",
   "authType": "string",
   "id": "string",
   "identitySource": "string",
   "identityValidationExpression": "string",
   "name": "string",
   "providerARNs": [ "string" ],
   "type": "string"
}
```

## Response Elements
<a name="API_UpdateAuthorizer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [authorizerCredentials](#API_UpdateAuthorizer_ResponseSyntax) **   <a name="apigw-UpdateAuthorizer-response-authorizerCredentials"></a>
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.  
Type: String

 ** [authorizerResultTtlInSeconds](#API_UpdateAuthorizer_ResponseSyntax) **   <a name="apigw-UpdateAuthorizer-response-authorizerResultTtlInSeconds"></a>
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.  
Type: Integer

 ** [authorizerUri](#API_UpdateAuthorizer_ResponseSyntax) **   <a name="apigw-UpdateAuthorizer-response-authorizerUri"></a>
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`.  
Type: String

 ** [authType](#API_UpdateAuthorizer_ResponseSyntax) **   <a name="apigw-UpdateAuthorizer-response-authType"></a>
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.  
Type: String

 ** [id](#API_UpdateAuthorizer_ResponseSyntax) **   <a name="apigw-UpdateAuthorizer-response-id"></a>
The identifier for the authorizer resource.  
Type: String

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

 ** [identityValidationExpression](#API_UpdateAuthorizer_ResponseSyntax) **   <a name="apigw-UpdateAuthorizer-response-identityValidationExpression"></a>
A validation expression for the incoming identity token. For `TOKEN` authorizers, this value is a regular expression. For `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the `REQUEST` authorizer.  
Type: String

 ** [name](#API_UpdateAuthorizer_ResponseSyntax) **   <a name="apigw-UpdateAuthorizer-response-name"></a>
The name of the authorizer.  
Type: String

 ** [providerARNs](#API_UpdateAuthorizer_ResponseSyntax) **   <a name="apigw-UpdateAuthorizer-response-providerARNs"></a>
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.   
Type: Array of strings

 ** [type](#API_UpdateAuthorizer_ResponseSyntax) **   <a name="apigw-UpdateAuthorizer-response-type"></a>
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.  
Type: String  
Valid Values: `TOKEN | REQUEST | COGNITO_USER_POOLS` 

## Errors
<a name="API_UpdateAuthorizer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateAuthorizer_Examples"></a>

### Update a custom authorizer
<a name="API_UpdateAuthorizer_Example_1"></a>

 The following request updates the `identitySource` property of a custom authorizer to use a different header to pass the token used by the specified custom authorizer. 

#### Sample Request
<a name="API_UpdateAuthorizer_Example_1_Request"></a>

```
PATCH /restapis/mxsmn867vb/authorizers/4unj71 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T233106Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "patchOperations" : [ {
    "op" : "replace",
    "path" : "/identitySource",
    "value" : "method.request.header.ApiAuth"
  }]
}
```

#### Sample Response
<a name="API_UpdateAuthorizer_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-authorizer-{rel}.html",
      "name": "authorizer",
      "templated": true
    },
    "self": {
      "href": "/restapis/mxsmn867vb/authorizers/4unj71"
    },
    "authorizer:delete": {
      "href": "/restapis/mxsmn867vb/authorizers/4unj71"
    },
    "authorizer:update": {
      "href": "/restapis/mxsmn867vb/authorizers/4unj71"
    }
  },
  "authType": "custom",
  "authorizerCredentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole",
  "authorizerResultTtlInSeconds": 300,
  "authorizerUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789012:function:myApiAuthroizer/invocations",
  "id": "4unj71",
  "identitySource": "method.request.header.ApiAuth",
  "name": "my-other-cust-auth",
  "type": "TOKEN"
}
```

## See Also
<a name="API_UpdateAuthorizer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateAuthorizer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateAuthorizer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateAuthorizer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateAuthorizer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateAuthorizer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateAuthorizer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateAuthorizer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateAuthorizer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateAuthorizer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateAuthorizer) 

# UpdateBasePathMapping
<a name="API_UpdateBasePathMapping"></a>

Changes information about the BasePathMapping resource.

## Request Syntax
<a name="API_UpdateBasePathMapping_RequestSyntax"></a>

```
PATCH /domainnames/domain_name/basepathmappings/base_path?domainNameId=domainNameId HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateBasePathMapping_RequestParameters"></a>

The request uses the following URI parameters.

 ** [base\$1path](#API_UpdateBasePathMapping_RequestSyntax) **   <a name="apigw-UpdateBasePathMapping-request-uri-basePath"></a>
The base path of the BasePathMapping resource to change.  
To specify an empty base path, set this parameter to `'(none)'`.  
Required: Yes

 ** [domain\$1name](#API_UpdateBasePathMapping_RequestSyntax) **   <a name="apigw-UpdateBasePathMapping-request-uri-domainName"></a>
The domain name of the BasePathMapping resource to change.  
Required: Yes

 ** [domainNameId](#API_UpdateBasePathMapping_RequestSyntax) **   <a name="apigw-UpdateBasePathMapping-request-uri-domainNameId"></a>
 The identifier for the domain name resource. Supported only for private custom domain names. 

## Request Body
<a name="API_UpdateBasePathMapping_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateBasePathMapping_RequestSyntax) **   <a name="apigw-UpdateBasePathMapping-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateBasePathMapping_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "basePath": "string",
   "restApiId": "string",
   "stage": "string"
}
```

## Response Elements
<a name="API_UpdateBasePathMapping_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [basePath](#API_UpdateBasePathMapping_ResponseSyntax) **   <a name="apigw-UpdateBasePathMapping-response-basePath"></a>
The base path name that callers of the API must provide as part of the URL after the domain name.  
Type: String

 ** [restApiId](#API_UpdateBasePathMapping_ResponseSyntax) **   <a name="apigw-UpdateBasePathMapping-response-restApiId"></a>
The string identifier of the associated RestApi.  
Type: String

 ** [stage](#API_UpdateBasePathMapping_ResponseSyntax) **   <a name="apigw-UpdateBasePathMapping-response-stage"></a>
The name of the associated stage.  
Type: String

## Errors
<a name="API_UpdateBasePathMapping_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateBasePathMapping_Examples"></a>

### Update the base path mapping of an API
<a name="API_UpdateBasePathMapping_Example_1"></a>

 The following example request updates the base path (`TestApi`) of a custom domain name (`a.b.c.com`) to map to a different deployment stage (`stage2 `of an API (`fugvjdxtri`).

#### Sample Request
<a name="API_UpdateBasePathMapping_Example_1_Request"></a>

```
PATCH /domainnames/a.b.c.com/basepathmappings/TestApi HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160615T025216Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160615/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "patchOperations" : [ {
    "op" : "replace",
    "path" : "/stage",
    "value" : "stage2"
  } ]
}
```

#### Sample Response
<a name="API_UpdateBasePathMapping_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-basepathmapping-{rel}.html",
      "name": "basepathmapping",
      "templated": true
    },
    "self": {
      "href": "/domainnames/a.b.c.com/basepathmappings/TestApi"
    },
    "basepathmapping:create": {
      "href": "/domainnames/a.b.c.com/basepathmappings"
    },
    "basepathmapping:delete": {
      "href": "/domainnames/a.b.c.com/basepathmappings/TestApi"
    },
    "basepathmapping:update": {
      "href": "/domainnames/a.b.c.com/basepathmappings/TestApi"
    }
  },
  "basepath": "TestApi",
  "restApiId": "fugvjdxtri",
  "stage": "stage2"
}
```

## See Also
<a name="API_UpdateBasePathMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateBasePathMapping) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateBasePathMapping) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateBasePathMapping) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateBasePathMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateBasePathMapping) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateBasePathMapping) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateBasePathMapping) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateBasePathMapping) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateBasePathMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateBasePathMapping) 

# UpdateClientCertificate
<a name="API_UpdateClientCertificate"></a>

Changes information about an ClientCertificate resource.

## Request Syntax
<a name="API_UpdateClientCertificate_RequestSyntax"></a>

```
PATCH /clientcertificates/clientcertificate_id HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateClientCertificate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientcertificate\$1id](#API_UpdateClientCertificate_RequestSyntax) **   <a name="apigw-UpdateClientCertificate-request-uri-clientCertificateId"></a>
The identifier of the ClientCertificate resource to be updated.  
Required: Yes

## Request Body
<a name="API_UpdateClientCertificate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateClientCertificate_RequestSyntax) **   <a name="apigw-UpdateClientCertificate-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateClientCertificate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "clientCertificateId": "string",
   "createdDate": number,
   "description": "string",
   "expirationDate": number,
   "pemEncodedCertificate": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_UpdateClientCertificate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [clientCertificateId](#API_UpdateClientCertificate_ResponseSyntax) **   <a name="apigw-UpdateClientCertificate-response-clientCertificateId"></a>
The identifier of the client certificate.  
Type: String

 ** [createdDate](#API_UpdateClientCertificate_ResponseSyntax) **   <a name="apigw-UpdateClientCertificate-response-createdDate"></a>
The timestamp when the client certificate was created.  
Type: Timestamp

 ** [description](#API_UpdateClientCertificate_ResponseSyntax) **   <a name="apigw-UpdateClientCertificate-response-description"></a>
The description of the client certificate.  
Type: String

 ** [expirationDate](#API_UpdateClientCertificate_ResponseSyntax) **   <a name="apigw-UpdateClientCertificate-response-expirationDate"></a>
The timestamp when the client certificate will expire.  
Type: Timestamp

 ** [pemEncodedCertificate](#API_UpdateClientCertificate_ResponseSyntax) **   <a name="apigw-UpdateClientCertificate-response-pemEncodedCertificate"></a>
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .  
Type: String

 ** [tags](#API_UpdateClientCertificate_ResponseSyntax) **   <a name="apigw-UpdateClientCertificate-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

## Errors
<a name="API_UpdateClientCertificate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateClientCertificate_Examples"></a>

### Update the description of a client-side certificate
<a name="API_UpdateClientCertificate_Example_1"></a>

This example illustrates one usage of UpdateClientCertificate.

#### Sample Request
<a name="API_UpdateClientCertificate_Example_1_Request"></a>

```
PATCH /clientcertificates/9ao60f HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160615T225025Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160615/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "patchOperations" : [ {
    "op" : "replace",
    "path" : "/description",
    "value" : "my second client-side cert"
  } ]
}
```

#### Sample Response
<a name="API_UpdateClientCertificate_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-clientcertificate-{rel}.html",
      "name": "clientcertificate",
      "templated": true
    },
    "self": {
      "href": "/clientcertificates/9ao60f"
    },
    "clientcertificate:delete": {
      "href": "/clientcertificates/9ao60f"
    },
    "clientcertificate:update": {
      "href": "/clientcertificates/9ao60f"
    }
  },
  "clientCertificateId": "9ao60f",
  "createdDate": "2016-06-15T22:33:13Z",
  "description": "my second client-side cert",
  "expirationDate": "2017-06-15T22:33:13Z",
  "pemEncodedCertificate": "-----BEGIN CERTIFICATE-----\r\nMIIC6TC...yQAGEHvs=\r\n-----END CERTIFICATE-----"
}
```

## See Also
<a name="API_UpdateClientCertificate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateClientCertificate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateClientCertificate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateClientCertificate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateClientCertificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateClientCertificate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateClientCertificate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateClientCertificate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateClientCertificate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateClientCertificate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateClientCertificate) 

# UpdateDeployment
<a name="API_UpdateDeployment"></a>

Changes information about a Deployment resource.

## Request Syntax
<a name="API_UpdateDeployment_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/deployments/deployment_id HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateDeployment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [deployment\$1id](#API_UpdateDeployment_RequestSyntax) **   <a name="apigw-UpdateDeployment-request-uri-deploymentId"></a>
The replacement identifier for the Deployment resource to change information about.  
Required: Yes

 ** [restapi\$1id](#API_UpdateDeployment_RequestSyntax) **   <a name="apigw-UpdateDeployment-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_UpdateDeployment_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateDeployment_RequestSyntax) **   <a name="apigw-UpdateDeployment-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateDeployment_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "apiSummary": { 
      "string" : { 
         "string" : { 
            "apiKeyRequired": boolean,
            "authorizationType": "string"
         }
      }
   },
   "createdDate": number,
   "description": "string",
   "id": "string"
}
```

## Response Elements
<a name="API_UpdateDeployment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [apiSummary](#API_UpdateDeployment_ResponseSyntax) **   <a name="apigw-UpdateDeployment-response-apiSummary"></a>
A summary of the RestApi at the date and time that the deployment resource was created.  
Type: String to string to [MethodSnapshot](API_MethodSnapshot.md) object map map

 ** [createdDate](#API_UpdateDeployment_ResponseSyntax) **   <a name="apigw-UpdateDeployment-response-createdDate"></a>
The date and time that the deployment resource was created.  
Type: Timestamp

 ** [description](#API_UpdateDeployment_ResponseSyntax) **   <a name="apigw-UpdateDeployment-response-description"></a>
The description for the deployment resource.  
Type: String

 ** [id](#API_UpdateDeployment_ResponseSyntax) **   <a name="apigw-UpdateDeployment-response-id"></a>
The identifier for the deployment resource.  
Type: String

## Errors
<a name="API_UpdateDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** ServiceUnavailableException **   
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.  
HTTP Status Code: 503

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateDeployment_Examples"></a>

### Update a deployment description
<a name="API_UpdateDeployment_Example_1"></a>

This example illustrates one usage of UpdateDeployment.

#### Sample Request
<a name="API_UpdateDeployment_Example_1_Request"></a>

```
PATCH /restapis/fugvjdxtri/deployments/dzacq7 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160603T192159Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "patchOperations" : [ {
    "op" : "replace",
    "path" : "/description",
    "value" : "Updated first deployment"
  } ]
}
```

#### Sample Response
<a name="API_UpdateDeployment_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-deployment-{rel}.html",
      "name": "deployment",
      "templated": true
    },
    "self": {
      "href": "/restapis/fugvjdxtri/deployments/dzacq7"
    },
    "deployment:delete": {
      "href": "/restapis/fugvjdxtri/deployments/dzacq7"
    },
    "deployment:stages": {
      "href": "/restapis/fugvjdxtri/stages?deployment_id=dzacq7"
    },
    "deployment:update": {
      "href": "/restapis/fugvjdxtri/deployments/dzacq7"
    }
  },
  "createdDate": "2016-06-03T17:56:06Z",
  "description": "Updated first deployment",
  "id": "dzacq7"
}
```

## See Also
<a name="API_UpdateDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateDeployment) 

# UpdateDocumentationPart
<a name="API_UpdateDocumentationPart"></a>

Updates a documentation part.

## Request Syntax
<a name="API_UpdateDocumentationPart_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/documentation/parts/part_id HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateDocumentationPart_RequestParameters"></a>

The request uses the following URI parameters.

 ** [part\$1id](#API_UpdateDocumentationPart_RequestSyntax) **   <a name="apigw-UpdateDocumentationPart-request-uri-documentationPartId"></a>
The identifier of the to-be-updated documentation part.  
Required: Yes

 ** [restapi\$1id](#API_UpdateDocumentationPart_RequestSyntax) **   <a name="apigw-UpdateDocumentationPart-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_UpdateDocumentationPart_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateDocumentationPart_RequestSyntax) **   <a name="apigw-UpdateDocumentationPart-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateDocumentationPart_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "id": "string",
   "location": { 
      "method": "string",
      "name": "string",
      "path": "string",
      "statusCode": "string",
      "type": "string"
   },
   "properties": "string"
}
```

## Response Elements
<a name="API_UpdateDocumentationPart_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [id](#API_UpdateDocumentationPart_ResponseSyntax) **   <a name="apigw-UpdateDocumentationPart-response-id"></a>
The DocumentationPart identifier, generated by API Gateway when the `DocumentationPart` is created.  
Type: String

 ** [location](#API_UpdateDocumentationPart_ResponseSyntax) **   <a name="apigw-UpdateDocumentationPart-response-location"></a>
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.  
Type: [DocumentationPartLocation](API_DocumentationPartLocation.md) object

 ** [properties](#API_UpdateDocumentationPart_ResponseSyntax) **   <a name="apigw-UpdateDocumentationPart-response-properties"></a>
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 OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of `x-amazon-apigateway-documentation`.  
Type: String

## Errors
<a name="API_UpdateDocumentationPart_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_UpdateDocumentationPart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateDocumentationPart) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateDocumentationPart) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateDocumentationPart) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateDocumentationPart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateDocumentationPart) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateDocumentationPart) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateDocumentationPart) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateDocumentationPart) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateDocumentationPart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateDocumentationPart) 

# UpdateDocumentationVersion
<a name="API_UpdateDocumentationVersion"></a>

Updates a documentation version.

## Request Syntax
<a name="API_UpdateDocumentationVersion_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/documentation/versions/doc_version HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateDocumentationVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [doc\$1version](#API_UpdateDocumentationVersion_RequestSyntax) **   <a name="apigw-UpdateDocumentationVersion-request-uri-documentationVersion"></a>
The version identifier of the to-be-updated documentation version.  
Required: Yes

 ** [restapi\$1id](#API_UpdateDocumentationVersion_RequestSyntax) **   <a name="apigw-UpdateDocumentationVersion-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_UpdateDocumentationVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateDocumentationVersion_RequestSyntax) **   <a name="apigw-UpdateDocumentationVersion-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateDocumentationVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdDate": number,
   "description": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_UpdateDocumentationVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdDate](#API_UpdateDocumentationVersion_ResponseSyntax) **   <a name="apigw-UpdateDocumentationVersion-response-createdDate"></a>
The date when the API documentation snapshot is created.  
Type: Timestamp

 ** [description](#API_UpdateDocumentationVersion_ResponseSyntax) **   <a name="apigw-UpdateDocumentationVersion-response-description"></a>
The description of the API documentation snapshot.  
Type: String

 ** [version](#API_UpdateDocumentationVersion_ResponseSyntax) **   <a name="apigw-UpdateDocumentationVersion-response-version"></a>
The version identifier of the API documentation snapshot.  
Type: String

## Errors
<a name="API_UpdateDocumentationVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_UpdateDocumentationVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateDocumentationVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateDocumentationVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateDocumentationVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateDocumentationVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateDocumentationVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateDocumentationVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateDocumentationVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateDocumentationVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateDocumentationVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateDocumentationVersion) 

# UpdateDomainName
<a name="API_UpdateDomainName"></a>

Changes information about the DomainName resource.

## Request Syntax
<a name="API_UpdateDomainName_RequestSyntax"></a>

```
PATCH /domainnames/domain_name?domainNameId=domainNameId HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateDomainName_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domain\$1name](#API_UpdateDomainName_RequestSyntax) **   <a name="apigw-UpdateDomainName-request-uri-domainName"></a>
The name of the DomainName resource to be changed.  
Required: Yes

 ** [domainNameId](#API_UpdateDomainName_RequestSyntax) **   <a name="apigw-UpdateDomainName-request-uri-domainNameId"></a>
 The identifier for the domain name resource. Supported only for private custom domain names. 

## Request Body
<a name="API_UpdateDomainName_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateDomainName_RequestSyntax) **   <a name="apigw-UpdateDomainName-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateDomainName_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "certificateArn": "string",
   "certificateName": "string",
   "certificateUploadDate": number,
   "distributionDomainName": "string",
   "distributionHostedZoneId": "string",
   "domainName": "string",
   "domainNameArn": "string",
   "domainNameId": "string",
   "domainNameStatus": "string",
   "domainNameStatusMessage": "string",
   "endpointAccessMode": "string",
   "endpointConfiguration": { 
      "ipAddressType": "string",
      "types": [ "string" ],
      "vpcEndpointIds": [ "string" ]
   },
   "managementPolicy": "string",
   "mutualTlsAuthentication": { 
      "truststoreUri": "string",
      "truststoreVersion": "string",
      "truststoreWarnings": [ "string" ]
   },
   "ownershipVerificationCertificateArn": "string",
   "policy": "string",
   "regionalCertificateArn": "string",
   "regionalCertificateName": "string",
   "regionalDomainName": "string",
   "regionalHostedZoneId": "string",
   "routingMode": "string",
   "securityPolicy": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_UpdateDomainName_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [certificateArn](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-certificateArn"></a>
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. AWS Certificate Manager is the only supported source.  
Type: String

 ** [certificateName](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-certificateName"></a>
The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.  
Type: String

 ** [certificateUploadDate](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-certificateUploadDate"></a>
The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.  
Type: Timestamp

 ** [distributionDomainName](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-distributionDomainName"></a>
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.  
Type: String

 ** [distributionHostedZoneId](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-distributionHostedZoneId"></a>
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.   
Type: String

 ** [domainName](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-domainName"></a>
The custom domain name as an API host name, for example, `my-api.example.com`.  
Type: String

 ** [domainNameArn](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-domainNameArn"></a>
The ARN of the domain name.   
Type: String

 ** [domainNameId](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-domainNameId"></a>
The identifier for the domain name resource. Supported only for private custom domain names.  
Type: String

 ** [domainNameStatus](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-domainNameStatus"></a>
The status of the DomainName migration. The valid values are `AVAILABLE` and `UPDATING`. If the status is `UPDATING`, the domain cannot be modified further until the existing operation is complete. If it is `AVAILABLE`, the domain can be updated.  
Type: String  
Valid Values: `AVAILABLE | UPDATING | PENDING | PENDING_CERTIFICATE_REIMPORT | PENDING_OWNERSHIP_VERIFICATION | FAILED` 

 ** [domainNameStatusMessage](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-domainNameStatusMessage"></a>
An optional text message containing detailed information about status of the DomainName migration.  
Type: String

 ** [endpointAccessMode](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-endpointAccessMode"></a>
 The endpoint access mode of the DomainName.   
Type: String  
Valid Values: `BASIC | STRICT` 

 ** [endpointConfiguration](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-endpointConfiguration"></a>
The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.   
Type: [EndpointConfiguration](API_EndpointConfiguration.md) object

 ** [managementPolicy](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-managementPolicy"></a>
A stringified JSON policy document that applies to the API Gateway Management service for this DomainName. This policy document controls access for access association sources to create domain name access associations with this DomainName. Supported only for private custom domain names.  
Type: String

 ** [mutualTlsAuthentication](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-mutualTlsAuthentication"></a>
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.  
Type: [MutualTlsAuthentication](API_MutualTlsAuthentication.md) object

 ** [ownershipVerificationCertificateArn](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-ownershipVerificationCertificateArn"></a>
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.  
Type: String

 ** [policy](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-policy"></a>
A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.  
Type: String

 ** [regionalCertificateArn](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-regionalCertificateArn"></a>
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.  
Type: String

 ** [regionalCertificateName](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-regionalCertificateName"></a>
The name of the certificate that will be used for validating the regional domain name.  
Type: String

 ** [regionalDomainName](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-regionalDomainName"></a>
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.  
Type: String

 ** [regionalHostedZoneId](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-regionalHostedZoneId"></a>
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.   
Type: String

 ** [routingMode](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-routingMode"></a>
The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your APIs.  
Type: String  
Valid Values: `BASE_PATH_MAPPING_ONLY | ROUTING_RULE_ONLY | ROUTING_RULE_THEN_BASE_PATH_MAPPING` 

 ** [securityPolicy](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-securityPolicy"></a>
The Transport Layer Security (TLS) version \$1 cipher suite for this DomainName.  
Type: String  
Valid Values: `TLS_1_0 | TLS_1_2 | SecurityPolicy_TLS13_1_3_2025_09 | SecurityPolicy_TLS13_1_3_FIPS_2025_09 | SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_PQ_2025_09 | SecurityPolicy_TLS13_1_2_2021_06 | SecurityPolicy_TLS13_2025_EDGE | SecurityPolicy_TLS12_PFS_2025_EDGE | SecurityPolicy_TLS12_2018_EDGE` 

 ** [tags](#API_UpdateDomainName_ResponseSyntax) **   <a name="apigw-UpdateDomainName-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

## Errors
<a name="API_UpdateDomainName_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateDomainName_Examples"></a>

### Rotate the certificate name of an edge-optimized custom domain name
<a name="API_UpdateDomainName_Example_1"></a>

This example illustrates one usage of UpdateDomainName.

#### Sample Request
<a name="API_UpdateDomainName_Example_1_Request"></a>

```
PATCH /domainnames/mon-api.com HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160615T214257Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160615/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "patchOperations" : [ {
    "op" : "replace",
    "path" : "/certificateName",
    "value" : "mon-api.com-cert-rotated-today"
    },{
    "op" : "replace",
    "path" : "/certificateArn",
    "value" : "arn:aws:acm:us-east-1:012345678910:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a"
  }]
}
```

#### Sample Response
<a name="API_UpdateDomainName_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-basepathmapping-{rel}.html",
        "name": "basepathmapping",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-domainname-{rel}.html",
        "name": "domainname",
        "templated": true
      }
    ],
    "self": {
      "href": "/domainnames/mon-api.com"
    },
    "basepathmapping:by-base-path": {
      "href": "/domainnames/mon-api.com/basepathmappings/{base_path}",
      "templated": true
    },
    "basepathmapping:create": {
      "href": "/domainnames/mon-api.com/basepathmappings"
    },
    "domainname:basepathmappings": {
      "href": "/domainnames/mon-api.com/basepathmappings{?limit}",
      "templated": true
    },
    "domainname:delete": {
      "href": "/domainnames/mon-api.com"
    },
    "domainname:update": {
      "href": "/domainnames/mon-api.com"
    }
  },
  "certificateArn": "arn:aws:acm:us-east-1:012345678910:certificate/34a95aa1-77fa-427c-aa07-3a88bd9f3c0a",
  "certificateName": "mon-api.com-cert-rotated-today",
  "certificateUploadDate": "2016-06-15T21:14:43Z",
  "distributionDomainName": "d2ck2x1vuc8qzh.cloudfront.net",
  "domainName": "mon-api.com"
}
```

## See Also
<a name="API_UpdateDomainName_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateDomainName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateDomainName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateDomainName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateDomainName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateDomainName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateDomainName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateDomainName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateDomainName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateDomainName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateDomainName) 

# UpdateGatewayResponse
<a name="API_UpdateGatewayResponse"></a>

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

## Request Syntax
<a name="API_UpdateGatewayResponse_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/gatewayresponses/response_type HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateGatewayResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [response\$1type](#API_UpdateGatewayResponse_RequestSyntax) **   <a name="apigw-UpdateGatewayResponse-request-uri-responseType"></a>
The response type of the associated GatewayResponse.  
Valid Values: `DEFAULT_4XX | DEFAULT_5XX | RESOURCE_NOT_FOUND | UNAUTHORIZED | INVALID_API_KEY | ACCESS_DENIED | AUTHORIZER_FAILURE | AUTHORIZER_CONFIGURATION_ERROR | INVALID_SIGNATURE | EXPIRED_TOKEN | MISSING_AUTHENTICATION_TOKEN | INTEGRATION_FAILURE | INTEGRATION_TIMEOUT | API_CONFIGURATION_ERROR | UNSUPPORTED_MEDIA_TYPE | BAD_REQUEST_PARAMETERS | BAD_REQUEST_BODY | REQUEST_TOO_LARGE | THROTTLED | QUOTA_EXCEEDED | WAF_FILTERED`   
Required: Yes

 ** [restapi\$1id](#API_UpdateGatewayResponse_RequestSyntax) **   <a name="apigw-UpdateGatewayResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_UpdateGatewayResponse_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateGatewayResponse_RequestSyntax) **   <a name="apigw-UpdateGatewayResponse-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateGatewayResponse_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "defaultResponse": boolean,
   "responseParameters": { 
      "string" : "string" 
   },
   "responseTemplates": { 
      "string" : "string" 
   },
   "responseType": "string",
   "statusCode": "string"
}
```

## Response Elements
<a name="API_UpdateGatewayResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [defaultResponse](#API_UpdateGatewayResponse_ResponseSyntax) **   <a name="apigw-UpdateGatewayResponse-response-defaultResponse"></a>
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.   
Type: Boolean

 ** [responseParameters](#API_UpdateGatewayResponse_ResponseSyntax) **   <a name="apigw-UpdateGatewayResponse-response-responseParameters"></a>
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.  
Type: String to string map

 ** [responseTemplates](#API_UpdateGatewayResponse_ResponseSyntax) **   <a name="apigw-UpdateGatewayResponse-response-responseTemplates"></a>
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.  
Type: String to string map

 ** [responseType](#API_UpdateGatewayResponse_ResponseSyntax) **   <a name="apigw-UpdateGatewayResponse-response-responseType"></a>
The response type of the associated GatewayResponse.  
Type: String  
Valid Values: `DEFAULT_4XX | DEFAULT_5XX | RESOURCE_NOT_FOUND | UNAUTHORIZED | INVALID_API_KEY | ACCESS_DENIED | AUTHORIZER_FAILURE | AUTHORIZER_CONFIGURATION_ERROR | INVALID_SIGNATURE | EXPIRED_TOKEN | MISSING_AUTHENTICATION_TOKEN | INTEGRATION_FAILURE | INTEGRATION_TIMEOUT | API_CONFIGURATION_ERROR | UNSUPPORTED_MEDIA_TYPE | BAD_REQUEST_PARAMETERS | BAD_REQUEST_BODY | REQUEST_TOO_LARGE | THROTTLED | QUOTA_EXCEEDED | WAF_FILTERED` 

 ** [statusCode](#API_UpdateGatewayResponse_ResponseSyntax) **   <a name="apigw-UpdateGatewayResponse-response-statusCode"></a>
The HTTP status code for this GatewayResponse.  
Type: String  
Pattern: `[1-5]\d\d` 

## Errors
<a name="API_UpdateGatewayResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateGatewayResponse_Examples"></a>

### Update a gateway response
<a name="API_UpdateGatewayResponse_Example_1"></a>

This example illustrates one usage of UpdateGatewayResponse.

#### Sample Request
<a name="API_UpdateGatewayResponse_Example_1_Request"></a>

```
PATCH /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1
Host: apigateway.us-east-1.amazonaws.com
Content-Type: application/json
X-Amz-Date: 20170503T070722Z
Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=69cc3552631a97....875d6931c497ace2
Cache-Control: no-cache
Postman-Token: 4ffd6473-f1e9-3b91-735d-658306e319de

{
  "patchOperations" : [
  {
    "op" : "replace",
    "path" : "/statusCode",
    "value" : "444"
  }, {
    "op" : "replace",
    "path" : "/responseParameters/gatewayresponse.header.Access-Control-Allow-Origin",
    "value" : "'example.com'"
  }, {
    "op" : "add",
    "path" : "/responseTemplates/application~1xml",
    "value" : "<gatewayResponse><message>$context.error.messageString</message><type>$context.error.responseType</type></gatewayResponse>"
  } ]
}
```

#### Sample Response
<a name="API_UpdateGatewayResponse_Example_1_Response"></a>

```
"_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": "'example.com'",
    "gatewayresponse.header.x-request-query": "method.request.querystring.q",
    "gatewayresponse.header.x-request-header": "method.request.header.Accept"
  },
  "responseTemplates": {
    "application/xml": "<gatewayResponse><message>$context.error.messageString</message><type>$context.error.responseType</type></gatewayResponse>",
    "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": "444"
}
```

## See Also
<a name="API_UpdateGatewayResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateGatewayResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateGatewayResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateGatewayResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateGatewayResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateGatewayResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateGatewayResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateGatewayResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateGatewayResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateGatewayResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateGatewayResponse) 

# UpdateIntegration
<a name="API_UpdateIntegration"></a>

Represents an update integration.

## Request Syntax
<a name="API_UpdateIntegration_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/resources/resource_id/methods/http_method/integration HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_UpdateIntegration_RequestSyntax) **   <a name="apigw-UpdateIntegration-request-uri-httpMethod"></a>
Represents an update integration request's HTTP method.  
Required: Yes

 ** [resource\$1id](#API_UpdateIntegration_RequestSyntax) **   <a name="apigw-UpdateIntegration-request-uri-resourceId"></a>
Represents an update integration request's resource identifier.  
Required: Yes

 ** [restapi\$1id](#API_UpdateIntegration_RequestSyntax) **   <a name="apigw-UpdateIntegration-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_UpdateIntegration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateIntegration_RequestSyntax) **   <a name="apigw-UpdateIntegration-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cacheKeyParameters": [ "string" ],
   "cacheNamespace": "string",
   "connectionId": "string",
   "connectionType": "string",
   "contentHandling": "string",
   "credentials": "string",
   "httpMethod": "string",
   "integrationResponses": { 
      "string" : { 
         "contentHandling": "string",
         "responseParameters": { 
            "string" : "string" 
         },
         "responseTemplates": { 
            "string" : "string" 
         },
         "selectionPattern": "string",
         "statusCode": "string"
      }
   },
   "integrationTarget": "string",
   "passthroughBehavior": "string",
   "requestParameters": { 
      "string" : "string" 
   },
   "requestTemplates": { 
      "string" : "string" 
   },
   "responseTransferMode": "string",
   "timeoutInMillis": number,
   "tlsConfig": { 
      "insecureSkipVerification": boolean
   },
   "type": "string",
   "uri": "string"
}
```

## Response Elements
<a name="API_UpdateIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cacheKeyParameters](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-cacheKeyParameters"></a>
A list of request parameters whose values API Gateway caches. To be valid values for `cacheKeyParameters`, these parameters must also be specified for Method `requestParameters`.  
Type: Array of strings

 ** [cacheNamespace](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-cacheNamespace"></a>
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the `cacheNamespace`. You can specify the same `cacheNamespace` across resources to return the same cached data for requests to different resources.  
Type: String

 ** [connectionId](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-connectionId"></a>
The ID of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise.  
Type: String

 ** [connectionType](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-connectionType"></a>
The type of the network connection to the integration endpoint. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.  
Type: String  
Valid Values: `INTERNET | VPC_LINK` 

 ** [contentHandling](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-contentHandling"></a>
Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors:  
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass-through.  
Type: String  
Valid Values: `CONVERT_TO_BINARY | CONVERT_TO_TEXT` 

 ** [credentials](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-credentials"></a>
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.  
Type: String

 ** [httpMethod](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-httpMethod"></a>
Specifies the integration's HTTP method type. For the Type property, if you specify `MOCK`, this property is optional. For Lambda integrations, you must set the integration method to `POST`. For all other types, you must specify this property.  
Type: String

 ** [integrationResponses](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-integrationResponses"></a>
Specifies the integration's responses.  
Type: String to [IntegrationResponse](API_IntegrationResponse.md) object map

 ** [integrationTarget](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-integrationTarget"></a>
 The ALB or NLB listener to send the request to.   
Type: String

 ** [passthroughBehavior](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-passthroughBehavior"></a>
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.  
Type: String

 ** [requestParameters](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-requestParameters"></a>
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.  
Type: String to string map

 ** [requestTemplates](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-requestTemplates"></a>
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.  
Type: String to string map

 ** [responseTransferMode](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-responseTransferMode"></a>
 The response transfer mode of the integration.   
Type: String  
Valid Values: `BUFFERED | STREAM` 

 ** [timeoutInMillis](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-timeoutInMillis"></a>
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.  
Type: Integer

 ** [tlsConfig](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-tlsConfig"></a>
Specifies the TLS configuration for an integration.  
Type: [TlsConfig](API_TlsConfig.md) object

 ** [type](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-type"></a>
Specifies an API method integration type. The valid value is one of the following:  
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.  
Type: String  
Valid Values: `HTTP | AWS | MOCK | HTTP_PROXY | AWS_PROXY` 

 ** [uri](#API_UpdateIntegration_ResponseSyntax) **   <a name="apigw-UpdateIntegration-response-uri"></a>
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 standard integrations. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name. For `AWS` or `AWS_PROXY` integrations, the URI is of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}`. Here, \$1Region\$1 is the API Gateway region (e.g., us-east-1); \$1service\$1 is the name of the integrated AWS service (e.g., s3); and \$1subdomain\$1 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=\$1name\$1&\$1p1\$1=\$1v1\$1&p2=\$1v2\$1... query string. The ensuing \$1service\$1api\$1 refers to a supported action \$1name\$1 plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service\$1api 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}`   
Type: String

## Errors
<a name="API_UpdateIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateIntegration_Examples"></a>

### Remove, add, and replace a request template
<a name="API_UpdateIntegration_Example_1"></a>

This example illustrates one usage of UpdateIntegration.

#### Sample Request
<a name="API_UpdateIntegration_Example_1_Request"></a>

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

{
  "patchOperations" : [ {
    "op" : "remove",
    "path" : "/requestTemplates/application~1xml"
  },
  {
    "op" : "add",
    "path" : "/requestTemplates/application~1xml",
    "value" : "
   
    3
   "
  },
  {
    "op" : "replace",
    "path" : "/requestTemplates/application~1xml",
    "value" : "
   
    3
   "
  } ]
}
```

#### Sample Response
<a name="API_UpdateIntegration_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
        "name": "integration",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
        "name": "integrationresponse",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis/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/xml": "
   
    3
   ",
    "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"
    }
  }
}
```

## See Also
<a name="API_UpdateIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateIntegration) 

# UpdateIntegrationResponse
<a name="API_UpdateIntegrationResponse"></a>

Represents an update integration response.

## Request Syntax
<a name="API_UpdateIntegrationResponse_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/resources/resource_id/methods/http_method/integration/responses/status_code HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateIntegrationResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_UpdateIntegrationResponse_RequestSyntax) **   <a name="apigw-UpdateIntegrationResponse-request-uri-httpMethod"></a>
Specifies an update integration response request's HTTP method.  
Required: Yes

 ** [resource\$1id](#API_UpdateIntegrationResponse_RequestSyntax) **   <a name="apigw-UpdateIntegrationResponse-request-uri-resourceId"></a>
Specifies an update integration response request's resource identifier.  
Required: Yes

 ** [restapi\$1id](#API_UpdateIntegrationResponse_RequestSyntax) **   <a name="apigw-UpdateIntegrationResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [status\$1code](#API_UpdateIntegrationResponse_RequestSyntax) **   <a name="apigw-UpdateIntegrationResponse-request-uri-statusCode"></a>
Specifies an update integration response request's status code.  
Pattern: `[1-5]\d\d`   
Required: Yes

## Request Body
<a name="API_UpdateIntegrationResponse_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateIntegrationResponse_RequestSyntax) **   <a name="apigw-UpdateIntegrationResponse-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateIntegrationResponse_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contentHandling": "string",
   "responseParameters": { 
      "string" : "string" 
   },
   "responseTemplates": { 
      "string" : "string" 
   },
   "selectionPattern": "string",
   "statusCode": "string"
}
```

## Response Elements
<a name="API_UpdateIntegrationResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contentHandling](#API_UpdateIntegrationResponse_ResponseSyntax) **   <a name="apigw-UpdateIntegrationResponse-response-contentHandling"></a>
Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors:  
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.  
Type: String  
Valid Values: `CONVERT_TO_BINARY | CONVERT_TO_TEXT` 

 ** [responseParameters](#API_UpdateIntegrationResponse_ResponseSyntax) **   <a name="apigw-UpdateIntegrationResponse-response-responseParameters"></a>
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.  
Type: String to string map

 ** [responseTemplates](#API_UpdateIntegrationResponse_ResponseSyntax) **   <a name="apigw-UpdateIntegrationResponse-response-responseTemplates"></a>
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.  
Type: String to string map

 ** [selectionPattern](#API_UpdateIntegrationResponse_ResponseSyntax) **   <a name="apigw-UpdateIntegrationResponse-response-selectionPattern"></a>
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.  
Type: String

 ** [statusCode](#API_UpdateIntegrationResponse_ResponseSyntax) **   <a name="apigw-UpdateIntegrationResponse-response-statusCode"></a>
Specifies the status code that is used to map the integration response to an existing MethodResponse.  
Type: String  
Pattern: `[1-5]\d\d` 

## Errors
<a name="API_UpdateIntegrationResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateIntegrationResponse_Examples"></a>

### Update a response template
<a name="API_UpdateIntegrationResponse_Example_1"></a>

This example illustrates one usage of UpdateIntegrationResponse.

#### Sample Request
<a name="API_UpdateIntegrationResponse_Example_1_Request"></a>

```
PATCH /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: 20160615T002050Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160615/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "patchOperations" : [ {
    "op" : "replace",
    "path" : "/responseTemplates/application~1json",
    "value": "{\n}"
  }]
}
```

#### Sample Response
<a name="API_UpdateIntegrationResponse_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
      "name": "integrationresponse",
      "templated": true
    },
    "self": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200",
      "title": "200"
    },
    "integrationresponse:delete": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
    },
    "integrationresponse:update": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200"
    }
  },
  "responseTemplates": {
    "application/json": "{\n}"
  },
  "statusCode": "200"
}
```

## See Also
<a name="API_UpdateIntegrationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateIntegrationResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateIntegrationResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateIntegrationResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateIntegrationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateIntegrationResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateIntegrationResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateIntegrationResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateIntegrationResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateIntegrationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateIntegrationResponse) 

# UpdateMethod
<a name="API_UpdateMethod"></a>

Updates an existing Method resource.

## Request Syntax
<a name="API_UpdateMethod_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/resources/resource_id/methods/http_method HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateMethod_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_UpdateMethod_RequestSyntax) **   <a name="apigw-UpdateMethod-request-uri-httpMethod"></a>
The HTTP verb of the Method resource.  
Required: Yes

 ** [resource\$1id](#API_UpdateMethod_RequestSyntax) **   <a name="apigw-UpdateMethod-request-uri-resourceId"></a>
The Resource identifier for the Method resource.  
Required: Yes

 ** [restapi\$1id](#API_UpdateMethod_RequestSyntax) **   <a name="apigw-UpdateMethod-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_UpdateMethod_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateMethod_RequestSyntax) **   <a name="apigw-UpdateMethod-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateMethod_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "apiKeyRequired": boolean,
   "authorizationScopes": [ "string" ],
   "authorizationType": "string",
   "authorizerId": "string",
   "httpMethod": "string",
   "methodIntegration": { 
      "cacheKeyParameters": [ "string" ],
      "cacheNamespace": "string",
      "connectionId": "string",
      "connectionType": "string",
      "contentHandling": "string",
      "credentials": "string",
      "httpMethod": "string",
      "integrationResponses": { 
         "string" : { 
            "contentHandling": "string",
            "responseParameters": { 
               "string" : "string" 
            },
            "responseTemplates": { 
               "string" : "string" 
            },
            "selectionPattern": "string",
            "statusCode": "string"
         }
      },
      "integrationTarget": "string",
      "passthroughBehavior": "string",
      "requestParameters": { 
         "string" : "string" 
      },
      "requestTemplates": { 
         "string" : "string" 
      },
      "responseTransferMode": "string",
      "timeoutInMillis": number,
      "tlsConfig": { 
         "insecureSkipVerification": boolean
      },
      "type": "string",
      "uri": "string"
   },
   "methodResponses": { 
      "string" : { 
         "responseModels": { 
            "string" : "string" 
         },
         "responseParameters": { 
            "string" : boolean 
         },
         "statusCode": "string"
      }
   },
   "operationName": "string",
   "requestModels": { 
      "string" : "string" 
   },
   "requestParameters": { 
      "string" : boolean 
   },
   "requestValidatorId": "string"
}
```

## Response Elements
<a name="API_UpdateMethod_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [apiKeyRequired](#API_UpdateMethod_ResponseSyntax) **   <a name="apigw-UpdateMethod-response-apiKeyRequired"></a>
A boolean flag specifying whether a valid ApiKey is required to invoke this method.  
Type: Boolean

 ** [authorizationScopes](#API_UpdateMethod_ResponseSyntax) **   <a name="apigw-UpdateMethod-response-authorizationScopes"></a>
A list of authorization scopes configured on the method. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.  
Type: Array of strings

 ** [authorizationType](#API_UpdateMethod_ResponseSyntax) **   <a name="apigw-UpdateMethod-response-authorizationType"></a>
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.  
Type: String

 ** [authorizerId](#API_UpdateMethod_ResponseSyntax) **   <a name="apigw-UpdateMethod-response-authorizerId"></a>
The identifier of an authorizer to use on this method. The method's authorization type must be `CUSTOM` or `COGNITO_USER_POOLS`.  
Type: String

 ** [httpMethod](#API_UpdateMethod_ResponseSyntax) **   <a name="apigw-UpdateMethod-response-httpMethod"></a>
The method's HTTP verb.  
Type: String

 ** [methodIntegration](#API_UpdateMethod_ResponseSyntax) **   <a name="apigw-UpdateMethod-response-methodIntegration"></a>
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.  
Type: [Integration](API_Integration.md) object

 ** [methodResponses](#API_UpdateMethod_ResponseSyntax) **   <a name="apigw-UpdateMethod-response-methodResponses"></a>
Gets a method response associated with a given HTTP status code.   
Type: String to [MethodResponse](API_MethodResponse.md) object map

 ** [operationName](#API_UpdateMethod_ResponseSyntax) **   <a name="apigw-UpdateMethod-response-operationName"></a>
A human-friendly operation identifier for the method. For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example.  
Type: String

 ** [requestModels](#API_UpdateMethod_ResponseSyntax) **   <a name="apigw-UpdateMethod-response-requestModels"></a>
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).  
Type: String to string map

 ** [requestParameters](#API_UpdateMethod_ResponseSyntax) **   <a name="apigw-UpdateMethod-response-requestParameters"></a>
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.  
Type: String to boolean map

 ** [requestValidatorId](#API_UpdateMethod_ResponseSyntax) **   <a name="apigw-UpdateMethod-response-requestValidatorId"></a>
The identifier of a RequestValidator for request validation.  
Type: String

## Errors
<a name="API_UpdateMethod_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateMethod_Examples"></a>

### Update a method to require use of an API key
<a name="API_UpdateMethod_Example_1"></a>

This example illustrates one usage of UpdateMethod.

#### Sample Request
<a name="API_UpdateMethod_Example_1_Request"></a>

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

{
  "patchOperations" : [ {
    "op" : "replace",
    "path" : "/apiKeyRequired",
    "value" : "true"
  } ]
```

#### Sample Response
<a name="API_UpdateMethod_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
        "name": "integration",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
        "name": "method",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
        "name": "methodresponse",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET",
      "name": "GET",
      "title": "GET"
    },
    "integration:put": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
    },
    "method:delete": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET"
    },
    "method: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"
}
```

## See Also
<a name="API_UpdateMethod_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateMethod) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateMethod) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateMethod) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateMethod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateMethod) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateMethod) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateMethod) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateMethod) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateMethod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateMethod) 

# UpdateMethodResponse
<a name="API_UpdateMethodResponse"></a>

Updates an existing MethodResponse resource.

## Request Syntax
<a name="API_UpdateMethodResponse_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/resources/resource_id/methods/http_method/responses/status_code HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateMethodResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_UpdateMethodResponse_RequestSyntax) **   <a name="apigw-UpdateMethodResponse-request-uri-httpMethod"></a>
The HTTP verb of the Method resource.  
Required: Yes

 ** [resource\$1id](#API_UpdateMethodResponse_RequestSyntax) **   <a name="apigw-UpdateMethodResponse-request-uri-resourceId"></a>
The Resource identifier for the MethodResponse resource.  
Required: Yes

 ** [restapi\$1id](#API_UpdateMethodResponse_RequestSyntax) **   <a name="apigw-UpdateMethodResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [status\$1code](#API_UpdateMethodResponse_RequestSyntax) **   <a name="apigw-UpdateMethodResponse-request-uri-statusCode"></a>
The status code for the MethodResponse resource.  
Pattern: `[1-5]\d\d`   
Required: Yes

## Request Body
<a name="API_UpdateMethodResponse_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateMethodResponse_RequestSyntax) **   <a name="apigw-UpdateMethodResponse-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateMethodResponse_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "responseModels": { 
      "string" : "string" 
   },
   "responseParameters": { 
      "string" : boolean 
   },
   "statusCode": "string"
}
```

## Response Elements
<a name="API_UpdateMethodResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [responseModels](#API_UpdateMethodResponse_ResponseSyntax) **   <a name="apigw-UpdateMethodResponse-response-responseModels"></a>
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.  
Type: String to string map

 ** [responseParameters](#API_UpdateMethodResponse_ResponseSyntax) **   <a name="apigw-UpdateMethodResponse-response-responseParameters"></a>
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.)  
Type: String to boolean map

 ** [statusCode](#API_UpdateMethodResponse_ResponseSyntax) **   <a name="apigw-UpdateMethodResponse-response-statusCode"></a>
The method response's status code.  
Type: String  
Pattern: `[1-5]\d\d` 

## Errors
<a name="API_UpdateMethodResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateMethodResponse_Examples"></a>

### Update response parameters and models
<a name="API_UpdateMethodResponse_Example_1"></a>

This example illustrates one usage of UpdateMethodResponse.

#### Sample Request
<a name="API_UpdateMethodResponse_Example_1_Request"></a>

```
PATCH /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/x-amz-json-1.1
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160613T233140Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "patchOperations" : [ {
    "op" : "replace",
    "path" : "/responseParameters/method.response.header.operator",
    "value" : "true"
  },
  {
    "op" : "replace",
    "path" : "/responseModels/application~1json",
    "value" : "output"
  } ]
}
```

#### Sample Response
<a name="API_UpdateMethodResponse_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
      "name": "methodresponse",
      "templated": true
    },
    "self": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200",
      "title": "200"
    },
    "methodresponse:delete": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200"
    },
    "methodresponse:update": {
      "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200"
    }
  },
  "responseModels": {
    "application/json": "output"
  },
  "responseParameters": {
    "method.response.header.operator": true,
    "method.response.header.operand_2": false,
    "method.response.header.operand_1": false
  },
  "statusCode": "200"
}
```

## See Also
<a name="API_UpdateMethodResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateMethodResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateMethodResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateMethodResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateMethodResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateMethodResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateMethodResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateMethodResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateMethodResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateMethodResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateMethodResponse) 

# UpdateModel
<a name="API_UpdateModel"></a>

Changes information about a model. The maximum size of the model is 400 KB.

## Request Syntax
<a name="API_UpdateModel_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/models/model_name HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [model\$1name](#API_UpdateModel_RequestSyntax) **   <a name="apigw-UpdateModel-request-uri-modelName"></a>
The name of the model to update.  
Required: Yes

 ** [restapi\$1id](#API_UpdateModel_RequestSyntax) **   <a name="apigw-UpdateModel-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_UpdateModel_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateModel_RequestSyntax) **   <a name="apigw-UpdateModel-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateModel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contentType": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "schema": "string"
}
```

## Response Elements
<a name="API_UpdateModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contentType](#API_UpdateModel_ResponseSyntax) **   <a name="apigw-UpdateModel-response-contentType"></a>
The content-type for the model.  
Type: String

 ** [description](#API_UpdateModel_ResponseSyntax) **   <a name="apigw-UpdateModel-response-description"></a>
The description of the model.  
Type: String

 ** [id](#API_UpdateModel_ResponseSyntax) **   <a name="apigw-UpdateModel-response-id"></a>
The identifier for the model resource.  
Type: String

 ** [name](#API_UpdateModel_ResponseSyntax) **   <a name="apigw-UpdateModel-response-name"></a>
The name of the model. Must be an alphanumeric string.  
Type: String

 ** [schema](#API_UpdateModel_ResponseSyntax) **   <a name="apigw-UpdateModel-response-schema"></a>
The schema for the model. For `application/json` models, this should be JSON schema draft 4 model. Do not include "\$1\$1/" characters in the description of any properties because such "\$1\$1/" 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.  
Type: String

## Errors
<a name="API_UpdateModel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateModel_Examples"></a>

### Update the schema definition of a model
<a name="API_UpdateModel_Example_1"></a>

This example illustrates one usage of UpdateModel.

#### Sample Request
<a name="API_UpdateModel_Example_1_Request"></a>

```
PATCH /restapis/uojnr9hd57/models/output HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160614T004253Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160614/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "patchOperations" : [ {
    "op" : "replace",
    "path" : "/schema",
    "value" : "{\n\t\"title\": \"Calc output\",\n\t\"type\": \"object\",\n\t\"properties\": {\n\t\t\"a\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"b\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"op\": {\n\t\t\t\"description\": \"operation of +, -, * or /\",\n\t\t\t\"type\": \"string\"\n\t\t},\n\t\t\"c\": {\n\t\t    \"type\": \"number\"\n\t\t}\n\t},\n\t\"required\": [\"a\", \"b\", \"op\"]\n}\n"
  } ]
}
```

#### Sample Response
<a name="API_UpdateModel_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-model-{rel}.html",
      "name": "model",
      "templated": true
    },
    "self": {
      "href": "/restapis/uojnr9hd57/models/output?flatten=false"
    },
    "model:create": {
      "href": "/restapis/uojnr9hd57/models"
    },
    "model:delete": {
      "href": "/restapis/uojnr9hd57/models/output"
    },
    "model:generate-template": {
      "href": "/restapis/uojnr9hd57/models/output/default_template"
    },
    "model:update": {
      "href": "/restapis/uojnr9hd57/models/output"
    }
  },
  "contentType": "application/json",
  "id": "hkhn0z",
  "name": "output",
  "schema": "{\n\t\"title\": \"Calc output\",\n\t\"type\": \"object\",\n\t\"properties\": {\n\t\t\"a\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"b\": {\n\t\t\t\"type\": \"number\"\n\t\t},\n\t\t\"op\": {\n\t\t\t\"description\": \"operation of +, -, * or /\",\n\t\t\t\"type\": \"string\"\n\t\t},\n\t\t\"c\": {\n\t\t    \"type\": \"number\"\n\t\t}\n\t},\n\t\"required\": [\"a\", \"b\", \"op\"]\n}\n"
}
```

## See Also
<a name="API_UpdateModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateModel) 

# UpdateRequestValidator
<a name="API_UpdateRequestValidator"></a>

Updates a RequestValidator of a given RestApi.

## Request Syntax
<a name="API_UpdateRequestValidator_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/requestvalidators/requestvalidator_id HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateRequestValidator_RequestParameters"></a>

The request uses the following URI parameters.

 ** [requestvalidator\$1id](#API_UpdateRequestValidator_RequestSyntax) **   <a name="apigw-UpdateRequestValidator-request-uri-requestValidatorId"></a>
The identifier of RequestValidator to be updated.  
Required: Yes

 ** [restapi\$1id](#API_UpdateRequestValidator_RequestSyntax) **   <a name="apigw-UpdateRequestValidator-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_UpdateRequestValidator_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateRequestValidator_RequestSyntax) **   <a name="apigw-UpdateRequestValidator-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateRequestValidator_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "id": "string",
   "name": "string",
   "validateRequestBody": boolean,
   "validateRequestParameters": boolean
}
```

## Response Elements
<a name="API_UpdateRequestValidator_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [id](#API_UpdateRequestValidator_ResponseSyntax) **   <a name="apigw-UpdateRequestValidator-response-id"></a>
The identifier of this RequestValidator.  
Type: String

 ** [name](#API_UpdateRequestValidator_ResponseSyntax) **   <a name="apigw-UpdateRequestValidator-response-name"></a>
The name of this RequestValidator  
Type: String

 ** [validateRequestBody](#API_UpdateRequestValidator_ResponseSyntax) **   <a name="apigw-UpdateRequestValidator-response-validateRequestBody"></a>
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.  
Type: Boolean

 ** [validateRequestParameters](#API_UpdateRequestValidator_ResponseSyntax) **   <a name="apigw-UpdateRequestValidator-response-validateRequestParameters"></a>
A Boolean flag to indicate whether to validate request parameters (`true`) or not (`false`).  
Type: Boolean

## Errors
<a name="API_UpdateRequestValidator_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateRequestValidator_Examples"></a>

### Update a RequestValidator for an API
<a name="API_UpdateRequestValidator_Example_1"></a>

This example illustrates one usage of UpdateRequestValidator.

#### Sample Request
<a name="API_UpdateRequestValidator_Example_1_Request"></a>

```
PATCH /restapis/mkhqppt4e4/requestvalidators/3n5aa0 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T172652Z
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}

{
  "patchOperations" : [ {
    "op" : "replace",
    "path" : "/name",
    "value" : "body-parameters-switched"
  }, {
    "op" : "replace",
    "path" : "/validateRequestBody",
    "value" : "false"
  }, {
    "op" : "replace",
    "path" : "/validateRequestParameters",
    "value" : "true"
  } ]
}
```

#### Sample Response
<a name="API_UpdateRequestValidator_Example_1_Response"></a>

```
{
  "_links": {
    "self": {
      "href": "/restapis/mkhqppt4e4/requestvalidators/3n5aa0"
    },
    "request-validator-delete": {
      "href": "/restapis/mkhqppt4e4/requestvalidators/3n5aa0"
    },
    "request-validator-update": {
      "href": "/restapis/mkhqppt4e4/requestvalidators/3n5aa0"
    }
  },
  "id": "3n5aa0",
  "name": "body-parameters-switched",
  "validateRequestBody": false,
  "validateRequestParameters": true
}
```

## See Also
<a name="API_UpdateRequestValidator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateRequestValidator) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateRequestValidator) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateRequestValidator) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateRequestValidator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateRequestValidator) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateRequestValidator) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateRequestValidator) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateRequestValidator) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateRequestValidator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateRequestValidator) 

# UpdateResource
<a name="API_UpdateResource"></a>

Changes information about a Resource resource.

## Request Syntax
<a name="API_UpdateResource_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/resources/resource_id HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resource\$1id](#API_UpdateResource_RequestSyntax) **   <a name="apigw-UpdateResource-request-uri-resourceId"></a>
The identifier of the Resource resource.  
Required: Yes

 ** [restapi\$1id](#API_UpdateResource_RequestSyntax) **   <a name="apigw-UpdateResource-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_UpdateResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateResource_RequestSyntax) **   <a name="apigw-UpdateResource-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "id": "string",
   "parentId": "string",
   "path": "string",
   "pathPart": "string",
   "resourceMethods": { 
      "string" : { 
         "apiKeyRequired": boolean,
         "authorizationScopes": [ "string" ],
         "authorizationType": "string",
         "authorizerId": "string",
         "httpMethod": "string",
         "methodIntegration": { 
            "cacheKeyParameters": [ "string" ],
            "cacheNamespace": "string",
            "connectionId": "string",
            "connectionType": "string",
            "contentHandling": "string",
            "credentials": "string",
            "httpMethod": "string",
            "integrationResponses": { 
               "string" : { 
                  "contentHandling": "string",
                  "responseParameters": { 
                     "string" : "string" 
                  },
                  "responseTemplates": { 
                     "string" : "string" 
                  },
                  "selectionPattern": "string",
                  "statusCode": "string"
               }
            },
            "integrationTarget": "string",
            "passthroughBehavior": "string",
            "requestParameters": { 
               "string" : "string" 
            },
            "requestTemplates": { 
               "string" : "string" 
            },
            "responseTransferMode": "string",
            "timeoutInMillis": number,
            "tlsConfig": { 
               "insecureSkipVerification": boolean
            },
            "type": "string",
            "uri": "string"
         },
         "methodResponses": { 
            "string" : { 
               "responseModels": { 
                  "string" : "string" 
               },
               "responseParameters": { 
                  "string" : boolean 
               },
               "statusCode": "string"
            }
         },
         "operationName": "string",
         "requestModels": { 
            "string" : "string" 
         },
         "requestParameters": { 
            "string" : boolean 
         },
         "requestValidatorId": "string"
      }
   }
}
```

## Response Elements
<a name="API_UpdateResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [id](#API_UpdateResource_ResponseSyntax) **   <a name="apigw-UpdateResource-response-id"></a>
The resource's identifier.  
Type: String

 ** [parentId](#API_UpdateResource_ResponseSyntax) **   <a name="apigw-UpdateResource-response-parentId"></a>
The parent resource's identifier.  
Type: String

 ** [path](#API_UpdateResource_ResponseSyntax) **   <a name="apigw-UpdateResource-response-path"></a>
The full path for this resource.  
Type: String

 ** [pathPart](#API_UpdateResource_ResponseSyntax) **   <a name="apigw-UpdateResource-response-pathPart"></a>
The last path segment for this resource.  
Type: String

 ** [resourceMethods](#API_UpdateResource_ResponseSyntax) **   <a name="apigw-UpdateResource-response-resourceMethods"></a>
Gets an API resource's method of a given HTTP verb.  
Type: String to [Method](API_Method.md) object map

## Errors
<a name="API_UpdateResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateResource_Examples"></a>

### Update a resource
<a name="API_UpdateResource_Example_1"></a>

This example illustrates one usage of UpdateResource.

#### Sample Request
<a name="API_UpdateResource_Example_1_Request"></a>

```
PATCH /restapis/86l3267lf6/resources/h9m85b HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T185829Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
    "patchOperations" : [{
        "op": "replace",
        "path": "/pathPart",
        "value" : "r1-2"
    },
    {
        "op": "replace",
        "path": "/parentId",
        "value": "nprcay"
    }]
}
```

#### Sample Response
<a name="API_UpdateResource_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
        "name": "method",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-resource-{rel}.html",
        "name": "resource",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis/86l3267lf6/resources/h9m85b"
    },
    "method:by-http-method": {
      "href": "/restapis/86l3267lf6/resources/h9m85b/methods/{http_method}",
      "templated": true
    },
    "method:put": {
      "href": "/restapis/86l3267lf6/resources/h9m85b/methods/{http_method}",
      "templated": true
    },
    "resource:create-child": {
      "href": "/restapis/86l3267lf6/resources/h9m85b"
    },
    "resource:delete": {
      "href": "/restapis/86l3267lf6/resources/h9m85b"
    },
    "resource:update": {
      "href": "/restapis/86l3267lf6/resources/h9m85b"
    }
  },
  "id": "h9m85b",
  "parentId": "nprcay",
  "path": "/r1/r1-2",
  "pathPart": "r1-2"
}
```

## See Also
<a name="API_UpdateResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateResource) 

# UpdateRestApi
<a name="API_UpdateRestApi"></a>

Changes information about the specified API.

## Request Syntax
<a name="API_UpdateRestApi_RequestSyntax"></a>

```
PATCH /restapis/restapi_id HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateRestApi_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_UpdateRestApi_RequestSyntax) **   <a name="apigw-UpdateRestApi-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

## Request Body
<a name="API_UpdateRestApi_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateRestApi_RequestSyntax) **   <a name="apigw-UpdateRestApi-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateRestApi_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "apiKeySource": "string",
   "apiStatus": "string",
   "apiStatusMessage": "string",
   "binaryMediaTypes": [ "string" ],
   "createdDate": number,
   "description": "string",
   "disableExecuteApiEndpoint": boolean,
   "endpointAccessMode": "string",
   "endpointConfiguration": { 
      "ipAddressType": "string",
      "types": [ "string" ],
      "vpcEndpointIds": [ "string" ]
   },
   "id": "string",
   "minimumCompressionSize": number,
   "name": "string",
   "policy": "string",
   "rootResourceId": "string",
   "securityPolicy": "string",
   "tags": { 
      "string" : "string" 
   },
   "version": "string",
   "warnings": [ "string" ]
}
```

## Response Elements
<a name="API_UpdateRestApi_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [apiKeySource](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-apiKeySource"></a>
The source of the API key for metering requests according to a usage plan. Valid values are: >`HEADER` to read the API key from the `X-API-Key` header of a request. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer.  
Type: String  
Valid Values: `HEADER | AUTHORIZER` 

 ** [apiStatus](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-apiStatus"></a>
The ApiStatus of the RestApi.   
Type: String  
Valid Values: `UPDATING | AVAILABLE | PENDING | FAILED` 

 ** [apiStatusMessage](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-apiStatusMessage"></a>
 The status message of the RestApi. When the status message is `UPDATING` you can still invoke it.   
Type: String

 ** [binaryMediaTypes](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-binaryMediaTypes"></a>
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.  
Type: Array of strings

 ** [createdDate](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-createdDate"></a>
The timestamp when the API was created.  
Type: Timestamp

 ** [description](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-description"></a>
The API's description.  
Type: String

 ** [disableExecuteApiEndpoint](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-disableExecuteApiEndpoint"></a>
Specifies whether clients can invoke your API by using the default `execute-api` endpoint. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.  
Type: Boolean

 ** [endpointAccessMode](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-endpointAccessMode"></a>
 The endpoint access mode of the RestApi.   
Type: String  
Valid Values: `BASIC | STRICT` 

 ** [endpointConfiguration](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-endpointConfiguration"></a>
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.   
Type: [EndpointConfiguration](API_EndpointConfiguration.md) object

 ** [id](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-id"></a>
The API's identifier. This identifier is unique across all of your APIs in API Gateway.  
Type: String

 ** [minimumCompressionSize](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-minimumCompressionSize"></a>
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.  
Type: Integer

 ** [name](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-name"></a>
The API's name.  
Type: String

 ** [policy](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-policy"></a>
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.  
Type: String

 ** [rootResourceId](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-rootResourceId"></a>
The API's root resource ID.  
Type: String

 ** [securityPolicy](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-securityPolicy"></a>
 The Transport Layer Security (TLS) version \$1 cipher suite for this RestApi.   
Type: String  
Valid Values: `TLS_1_0 | TLS_1_2 | SecurityPolicy_TLS13_1_3_2025_09 | SecurityPolicy_TLS13_1_3_FIPS_2025_09 | SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09 | SecurityPolicy_TLS13_1_2_PQ_2025_09 | SecurityPolicy_TLS13_1_2_2021_06 | SecurityPolicy_TLS13_2025_EDGE | SecurityPolicy_TLS12_PFS_2025_EDGE | SecurityPolicy_TLS12_2018_EDGE` 

 ** [tags](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [version](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-version"></a>
A version identifier for the API.  
Type: String

 ** [warnings](#API_UpdateRestApi_ResponseSyntax) **   <a name="apigw-UpdateRestApi-response-warnings"></a>
The warning messages reported when `failonwarnings` is turned on during API import.  
Type: Array of strings

## Errors
<a name="API_UpdateRestApi_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateRestApi_Examples"></a>

### Update an API
<a name="API_UpdateRestApi_Example_1"></a>

This example illustrates one usage of UpdateRestApi.

#### Sample Request
<a name="API_UpdateRestApi_Example_1_Request"></a>

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

{
  "patchOperations" : [
    {
        "op" : "replace",
        "path" : "/name",
        "value" : "my-sample-api"
    },
    {
        "op" : "remove",
        "path" : "/description"
    },
    {
        "op" : "add",
        "path" : "/description",
        "value" : "A test API"
    }
  ]
}
```

#### Sample Response
<a name="API_UpdateRestApi_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-authorizer-{rel}.html",
        "name": "authorizer",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-deployment-{rel}.html",
        "name": "deployment",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-model-{rel}.html",
        "name": "model",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-resource-{rel}.html",
        "name": "resource",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-restapi-{rel}.html",
        "name": "restapi",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-stage-{rel}.html",
        "name": "stage",
        "templated": true
      }
    ],
    "self": {
      "href": "/restapis/fugvjdxtri"
    },
    "authorizer:by-id": {
      "href": "/restapis/fugvjdxtri/authorizers/{authorizer_id}",
      "templated": true
    },
    "authorizer:create": {
      "href": "/restapis/fugvjdxtri/authorizers"
    },
    "deployment:by-id": {
      "href": "/restapis/fugvjdxtri/deployments/{deployment_id}{?embed}",
      "templated": true
    },
    "deployment:create": {
      "href": "/restapis/fugvjdxtri/deployments"
    },
    "model:by-name": {
      "href": "/restapis/fugvjdxtri/models/{model_name}?flatten=false",
      "templated": true
    },
    "model:create": {
      "href": "/restapis/fugvjdxtri/models"
    },
    "resource:by-id": {
      "href": "/restapis/fugvjdxtri/resources/{resource_id}{?embed}",
      "templated": true
    },
    "resource:create": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2"
    },
    "restapi:authorizers": {
      "href": "/restapis/fugvjdxtri/authorizers"
    },
    "restapi:delete": {
      "href": "/restapis/fugvjdxtri"
    },
    "restapi:deployments": {
      "href": "/restapis/fugvjdxtri/deployments{?limit}",
      "templated": true
    },
    "restapi:models": {
      "href": "/restapis/fugvjdxtri/models"
    },
    "restapi:resources": {
      "href": "/restapis/fugvjdxtri/resources{?limit,embed}",
      "templated": true
    },
    "restapi:stages": {
      "href": "/restapis/fugvjdxtri/stages{?deployment_id}",
      "templated": true
    },
    "restapi:update": {
      "href": "/restapis/fugvjdxtri"
    },
    "stage:by-name": {
      "href": "/restapis/fugvjdxtri/stages/{stage_name}",
      "templated": true
    },
    "stage:create": {
      "href": "/restapis/fugvjdxtri/stages"
    }
  },
  "createdDate": "2016-06-01T18:53:41Z",
  "description": "A test API",
  "id": "fugvjdxtri",
  "name": "my-sample-api"
}
```

## See Also
<a name="API_UpdateRestApi_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateRestApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateRestApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateRestApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateRestApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateRestApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateRestApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateRestApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateRestApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateRestApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateRestApi) 

# UpdateStage
<a name="API_UpdateStage"></a>

Changes information about a Stage resource.

## Request Syntax
<a name="API_UpdateStage_RequestSyntax"></a>

```
PATCH /restapis/restapi_id/stages/stage_name HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateStage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restapi\$1id](#API_UpdateStage_RequestSyntax) **   <a name="apigw-UpdateStage-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [stage\$1name](#API_UpdateStage_RequestSyntax) **   <a name="apigw-UpdateStage-request-uri-stageName"></a>
The name of the Stage resource to change information about.  
Required: Yes

## Request Body
<a name="API_UpdateStage_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateStage_RequestSyntax) **   <a name="apigw-UpdateStage-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateStage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "accessLogSettings": { 
      "destinationArn": "string",
      "format": "string"
   },
   "cacheClusterEnabled": boolean,
   "cacheClusterSize": "string",
   "cacheClusterStatus": "string",
   "canarySettings": { 
      "deploymentId": "string",
      "percentTraffic": number,
      "stageVariableOverrides": { 
         "string" : "string" 
      },
      "useStageCache": boolean
   },
   "clientCertificateId": "string",
   "createdDate": number,
   "deploymentId": "string",
   "description": "string",
   "documentationVersion": "string",
   "lastUpdatedDate": number,
   "methodSettings": { 
      "string" : { 
         "cacheDataEncrypted": boolean,
         "cacheTtlInSeconds": number,
         "cachingEnabled": boolean,
         "dataTraceEnabled": boolean,
         "loggingLevel": "string",
         "metricsEnabled": boolean,
         "requireAuthorizationForCacheControl": boolean,
         "throttlingBurstLimit": number,
         "throttlingRateLimit": number,
         "unauthorizedCacheControlHeaderStrategy": "string"
      }
   },
   "stageName": "string",
   "tags": { 
      "string" : "string" 
   },
   "tracingEnabled": boolean,
   "variables": { 
      "string" : "string" 
   },
   "webAclArn": "string"
}
```

## Response Elements
<a name="API_UpdateStage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accessLogSettings](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-accessLogSettings"></a>
Settings for logging access in this stage.  
Type: [AccessLogSettings](API_AccessLogSettings.md) object

 ** [cacheClusterEnabled](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-cacheClusterEnabled"></a>
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set `CachingEnabled` to `true` for a method.   
Type: Boolean

 ** [cacheClusterSize](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-cacheClusterSize"></a>
The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).  
Type: String  
Valid Values: `0.5 | 1.6 | 6.1 | 13.5 | 28.4 | 58.2 | 118 | 237` 

 ** [cacheClusterStatus](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-cacheClusterStatus"></a>
The status of the cache cluster for the stage, if enabled.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | AVAILABLE | DELETE_IN_PROGRESS | NOT_AVAILABLE | FLUSH_IN_PROGRESS` 

 ** [canarySettings](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-canarySettings"></a>
Settings for the canary deployment in this stage.  
Type: [CanarySettings](API_CanarySettings.md) object

 ** [clientCertificateId](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-clientCertificateId"></a>
The identifier of a client certificate for an API stage.  
Type: String

 ** [createdDate](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-createdDate"></a>
The timestamp when the stage was created.  
Type: Timestamp

 ** [deploymentId](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-deploymentId"></a>
The identifier of the Deployment that the stage points to.  
Type: String

 ** [description](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-description"></a>
The stage's description.  
Type: String

 ** [documentationVersion](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-documentationVersion"></a>
The version of the associated API documentation.  
Type: String

 ** [lastUpdatedDate](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-lastUpdatedDate"></a>
The timestamp when the stage last updated.  
Type: Timestamp

 ** [methodSettings](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-methodSettings"></a>
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.   
Type: String to [MethodSetting](API_MethodSetting.md) object map

 ** [stageName](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-stageName"></a>
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.  
Type: String

 ** [tags](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [tracingEnabled](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-tracingEnabled"></a>
Specifies whether active tracing with X-ray is enabled for the Stage.  
Type: Boolean

 ** [variables](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-variables"></a>
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-._~:/?#&=,]+`.  
Type: String to string map

 ** [webAclArn](#API_UpdateStage_ResponseSyntax) **   <a name="apigw-UpdateStage-response-webAclArn"></a>
The ARN of the WebAcl associated with the Stage.  
Type: String

## Errors
<a name="API_UpdateStage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateStage_Examples"></a>

### Update a deployment stage
<a name="API_UpdateStage_Example_1"></a>

This example illustrates one usage of UpdateStage.

#### Sample Request
<a name="API_UpdateStage_Example_1_Request"></a>

```
PATCH /restapis/fugvjdxtri/stages/stage1 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160603T200400Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "patchOperations" : [
    {
        "op" : "replace",
        "path" : "/*/*/metrics/enabled",
        "value" : "true"
    },
    {
        "op" : "replace",
        "path" : "/cacheClusterEnabled",
        "value" : "true"
    },
    {
        "op" : "replace",
        "path" : "/cacheClusterSize",
        "value" : "0.5"
    },
    {
        "op" : "replace",
        "path" : "/variables/sv2",
        "value" : "svVar"
    }
  ]
}
```

#### Sample Response
<a name="API_UpdateStage_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-stage-{rel}.html",
      "name": "stage",
      "templated": true
    },
    "self": {
      "href": "/restapis/fugvjdxtri/stages/stage1"
    },
    "stage:delete": {
      "href": "/restapis/fugvjdxtri/stages/stage1"
    },
    "stage:flush-authorizer-cache": {
      "href": "/restapis/fugvjdxtri/stages/stage1/cache/authorizers"
    },
    "stage:flush-cache": {
      "href": "/restapis/fugvjdxtri/stages/stage1/cache/data"
    },
    "stage:update": {
      "href": "/restapis/fugvjdxtri/stages/stage1"
    }
  },
  "cacheClusterEnabled": true,
  "cacheClusterSize": "0.5",
  "cacheClusterStatus": "CREATE_IN_PROGRESS",
  "createdDate": "2016-06-03T17:56:06Z",
  "deploymentId": "dzacq7",
  "description": "First stage",
  "lastUpdatedDate": "2016-06-03T20:04:00Z",
  "methodSettings": {
    "/": {
      "dataTraceEnabled": false,
      "throttlingRateLimit": 500,
      "cacheTtlInSeconds": 0,
      "cachingEnabled": true,
      "requireAuthorizationForCacheControl": true,
      "metricsEnabled": true,
      "loggingLevel": "OFF",
      "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER",
      "throttlingBurstLimit": 1000,
      "cacheDataEncrypted": false
    }
  },
  "stageName": "stage1",
  "variables": {
    "sv2": "svVar",
    "sv1": "opVar"
  }
}
```

## See Also
<a name="API_UpdateStage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateStage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateStage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateStage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateStage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateStage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateStage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateStage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateStage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateStage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateStage) 

# UpdateUsage
<a name="API_UpdateUsage"></a>

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

## Request Syntax
<a name="API_UpdateUsage_RequestSyntax"></a>

```
PATCH /usageplans/usageplanId/keys/keyId/usage HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateUsage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [keyId](#API_UpdateUsage_RequestSyntax) **   <a name="apigw-UpdateUsage-request-uri-keyId"></a>
The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.  
Required: Yes

 ** [usageplanId](#API_UpdateUsage_RequestSyntax) **   <a name="apigw-UpdateUsage-request-uri-usagePlanId"></a>
The Id of the usage plan associated with the usage data.  
Required: Yes

## Request Body
<a name="API_UpdateUsage_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateUsage_RequestSyntax) **   <a name="apigw-UpdateUsage-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateUsage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "endDate": "string",
   "values": { 
      "string" : [ 
         [ number ]
      ]
   },
   "position": "string",
   "startDate": "string",
   "usagePlanId": "string"
}
```

## Response Elements
<a name="API_UpdateUsage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [endDate](#API_UpdateUsage_ResponseSyntax) **   <a name="apigw-UpdateUsage-response-endDate"></a>
The ending date of the usage data.  
Type: String

 ** [values](#API_UpdateUsage_ResponseSyntax) **   <a name="apigw-UpdateUsage-response-values"></a>
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 ID and the daily log entry is of the format `[used quota, remaining quota]`.  
Type: String to array of arrays of longs map

 ** [position](#API_UpdateUsage_ResponseSyntax) **   <a name="apigw-UpdateUsage-response-position"></a>
The current pagination position in the paged result set.  
Type: String

 ** [startDate](#API_UpdateUsage_ResponseSyntax) **   <a name="apigw-UpdateUsage-response-startDate"></a>
The starting date of the usage data.  
Type: String

 ** [usagePlanId](#API_UpdateUsage_ResponseSyntax) **   <a name="apigw-UpdateUsage-response-usagePlanId"></a>
The plan Id associated with this usage data.  
Type: String

## Errors
<a name="API_UpdateUsage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateUsage_Examples"></a>

### Update usage
<a name="API_UpdateUsage_Example_1"></a>

This example illustrates one usage of UpdateUsage.

#### Sample Request
<a name="API_UpdateUsage_Example_1_Request"></a>

```
PATCH /usageplans/ywbqww/keys/3JX4ISs7Ik23cDsgiaJdu6SiLffQpIsU7AyTMALs6/usage HTTP/1.1
Content-Type: application/json
Host: apigateway.ap-southeast-1.amazonaws.com
Content-Length: 114
X-Amz-Date: 20160801T235803Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160801/ap-southeast-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sigv4_hash}

{
    "patchOperation" : [ {
       "op": "replace",
       "path": "/remaining",
       "value": "10"
    } ]
}
```

#### Sample Response
<a name="API_UpdateUsage_Example_1_Response"></a>

```
{
  "_links": {
    "self": {
      "href": "/usageplans/ywbqww/keys/3JX4ISs7Ik23cDsgiaJdu6SiLffQpIsU7AyTMALs6/usage"
    }
  },
  "endDate": "2016-08-08",
  "startDate": "2016-08-08",
  "usagePlanId": "ywbqww",
  "values": {
    "3JX4ISs7Ik23cDsgiaJdu6SiLffQpIsU7AyTMALs6": [
      0,
      10
    ]
  }
}
```

## See Also
<a name="API_UpdateUsage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateUsage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateUsage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateUsage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateUsage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateUsage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateUsage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateUsage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateUsage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateUsage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateUsage) 

# UpdateUsagePlan
<a name="API_UpdateUsagePlan"></a>

Updates a usage plan of a given plan Id.

## Request Syntax
<a name="API_UpdateUsagePlan_RequestSyntax"></a>

```
PATCH /usageplans/usageplanId HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateUsagePlan_RequestParameters"></a>

The request uses the following URI parameters.

 ** [usageplanId](#API_UpdateUsagePlan_RequestSyntax) **   <a name="apigw-UpdateUsagePlan-request-uri-usagePlanId"></a>
The Id of the to-be-updated usage plan.  
Required: Yes

## Request Body
<a name="API_UpdateUsagePlan_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateUsagePlan_RequestSyntax) **   <a name="apigw-UpdateUsagePlan-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateUsagePlan_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "apiStages": [ 
      { 
         "apiId": "string",
         "stage": "string",
         "throttle": { 
            "string" : { 
               "burstLimit": number,
               "rateLimit": number
            }
         }
      }
   ],
   "description": "string",
   "id": "string",
   "name": "string",
   "productCode": "string",
   "quota": { 
      "limit": number,
      "offset": number,
      "period": "string"
   },
   "tags": { 
      "string" : "string" 
   },
   "throttle": { 
      "burstLimit": number,
      "rateLimit": number
   }
}
```

## Response Elements
<a name="API_UpdateUsagePlan_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [apiStages](#API_UpdateUsagePlan_ResponseSyntax) **   <a name="apigw-UpdateUsagePlan-response-apiStages"></a>
The associated API stages of a usage plan.  
Type: Array of [ApiStage](API_ApiStage.md) objects

 ** [description](#API_UpdateUsagePlan_ResponseSyntax) **   <a name="apigw-UpdateUsagePlan-response-description"></a>
The description of a usage plan.  
Type: String

 ** [id](#API_UpdateUsagePlan_ResponseSyntax) **   <a name="apigw-UpdateUsagePlan-response-id"></a>
The identifier of a UsagePlan resource.  
Type: String

 ** [name](#API_UpdateUsagePlan_ResponseSyntax) **   <a name="apigw-UpdateUsagePlan-response-name"></a>
The name of a usage plan.  
Type: String

 ** [productCode](#API_UpdateUsagePlan_ResponseSyntax) **   <a name="apigw-UpdateUsagePlan-response-productCode"></a>
The AWS Marketplace product identifier to associate with the usage plan as a SaaS product on the AWS Marketplace.  
Type: String

 ** [quota](#API_UpdateUsagePlan_ResponseSyntax) **   <a name="apigw-UpdateUsagePlan-response-quota"></a>
The target maximum number of permitted requests per a given unit time interval.  
Type: [QuotaSettings](API_QuotaSettings.md) object

 ** [tags](#API_UpdateUsagePlan_ResponseSyntax) **   <a name="apigw-UpdateUsagePlan-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [throttle](#API_UpdateUsagePlan_ResponseSyntax) **   <a name="apigw-UpdateUsagePlan-response-throttle"></a>
A map containing method level throttling information for API stage in a usage plan.  
Type: [ThrottleSettings](API_ThrottleSettings.md) object

## Errors
<a name="API_UpdateUsagePlan_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_UpdateUsagePlan_Examples"></a>

### Update a usage plan
<a name="API_UpdateUsagePlan_Example_1"></a>

This example illustrates one usage of UpdateUsagePlan.

#### Sample Request
<a name="API_UpdateUsagePlan_Example_1_Request"></a>

```
PATCH /usageplans/w0mvrr HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160805T200901Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160805/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sigv4_hash}

{
    "patchOperations" : [ {
       "op": "add",
       "path": "/apiStages",
       "value": "o81lxisefl:Stage_A"
    },
    {
       "op": "replace",
       "path": "/name",
       "value": "new-plan-name"
    },
    {
       "op": "replace",
       "path": "/description",
       "value": "new-plan-description"
    },
    {
        "op": "replace",
        "path": "/quota/period",
        "value": "MONTH"
    },
    {
        "op": "replace",
        "path": "/quota/limit",
        "value": "1300"
    },
    {
        "op": "replace",
        "path": "/quota/offset",
        "value": "5"
    }]
}
```

#### Sample Response
<a name="API_UpdateUsagePlan_Example_1_Response"></a>

```
{
  "_links": {
    "curies": [
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usage-{rel}.html",
        "name": "usage",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usageplan-{rel}.html",
        "name": "usageplan",
        "templated": true
      },
      {
        "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-usageplankey-{rel}.html",
        "name": "usageplankey",
        "templated": true
      }
    ],
    "self": {
      "href": "/usageplans/w0mvrr"
    },
    "usage:get": {
      "href": "/usageplans/w0mvrr/usage?startDate=2016-07-06&endDate=2016-08-05"
    },
    "usageplan:delete": {
      "href": "/usageplans/w0mvrr"
    },
    "usageplan:update": {
      "href": "/usageplans/w0mvrr"
    },
    "usageplan:usageplankeys": {
      "href": "/usageplans/w0mvrr/keys"
    },
    "usageplankey:create": {
      "href": "/usageplans/w0mvrr/keys"
    }
  },
  "apiStages": {
    "stage": "Stage_A",
    "apiId": "o81lxisefl"
  },
  "description": "new-plan-description",
  "id": "w0mvrr",
  "name": "new-plan-name",
  "quota": {
    "period": "MONTH",
    "offset": 5,
    "limit": 1300
  },
  "throttle": {
    "rateLimit": 100,
    "burstLimit": 200
  }
}
```

## See Also
<a name="API_UpdateUsagePlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateUsagePlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateUsagePlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateUsagePlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateUsagePlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateUsagePlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateUsagePlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateUsagePlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateUsagePlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateUsagePlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateUsagePlan) 

# UpdateVpcLink
<a name="API_UpdateVpcLink"></a>

Updates an existing VpcLink of a specified identifier.

## Request Syntax
<a name="API_UpdateVpcLink_RequestSyntax"></a>

```
PATCH /vpclinks/vpclink_id HTTP/1.1
Content-type: application/json

{
   "patchOperations": [ 
      { 
         "from": "string",
         "op": "string",
         "path": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateVpcLink_RequestParameters"></a>

The request uses the following URI parameters.

 ** [vpclink\$1id](#API_UpdateVpcLink_RequestSyntax) **   <a name="apigw-UpdateVpcLink-request-uri-vpcLinkId"></a>
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.  
Required: Yes

## Request Body
<a name="API_UpdateVpcLink_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [patchOperations](#API_UpdateVpcLink_RequestSyntax) **   <a name="apigw-UpdateVpcLink-request-patchOperations"></a>
For more information about supported patch operations, see [Patch Operations](patch-operations.md).  
Type: Array of [PatchOperation](API_PatchOperation.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateVpcLink_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "description": "string",
   "id": "string",
   "name": "string",
   "status": "string",
   "statusMessage": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetArns": [ "string" ]
}
```

## Response Elements
<a name="API_UpdateVpcLink_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [description](#API_UpdateVpcLink_ResponseSyntax) **   <a name="apigw-UpdateVpcLink-response-description"></a>
The description of the VPC link.  
Type: String

 ** [id](#API_UpdateVpcLink_ResponseSyntax) **   <a name="apigw-UpdateVpcLink-response-id"></a>
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.  
Type: String

 ** [name](#API_UpdateVpcLink_ResponseSyntax) **   <a name="apigw-UpdateVpcLink-response-name"></a>
The name used to label and identify the VPC link.  
Type: String

 ** [status](#API_UpdateVpcLink_ResponseSyntax) **   <a name="apigw-UpdateVpcLink-response-status"></a>
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`.   
Type: String  
Valid Values: `AVAILABLE | PENDING | DELETING | FAILED` 

 ** [statusMessage](#API_UpdateVpcLink_ResponseSyntax) **   <a name="apigw-UpdateVpcLink-response-statusMessage"></a>
A description about the VPC link status.  
Type: String

 ** [tags](#API_UpdateVpcLink_ResponseSyntax) **   <a name="apigw-UpdateVpcLink-response-tags"></a>
The collection of tags. Each tag element is associated with a given resource.  
Type: String to string map

 ** [targetArns](#API_UpdateVpcLink_ResponseSyntax) **   <a name="apigw-UpdateVpcLink-response-targetArns"></a>
The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.  
Type: Array of strings

## Errors
<a name="API_UpdateVpcLink_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## See Also
<a name="API_UpdateVpcLink_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/UpdateVpcLink) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/UpdateVpcLink) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/UpdateVpcLink) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/UpdateVpcLink) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/UpdateVpcLink) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/UpdateVpcLink) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/UpdateVpcLink) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/UpdateVpcLink) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/UpdateVpcLink) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/UpdateVpcLink)