Amazon API Gateway 2015-07-09
- Client: Aws\ApiGateway\ApiGatewayClient
- Service ID: apigateway
- Version: 2015-07-09
This page describes the parameters and results for the operations of the Amazon API Gateway (2015-07-09), and shows how to use the Aws\ApiGateway\ApiGatewayClient object to call the described operations. This documentation is specific to the 2015-07-09 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateApiKey ( array $params = [] )
- Create an ApiKey resource.
- CreateAuthorizer ( array $params = [] )
- Adds a new Authorizer resource to an existing RestApi resource.
- CreateBasePathMapping ( array $params = [] )
- Creates a new BasePathMapping resource.
- CreateDeployment ( array $params = [] )
- Creates a Deployment resource, which makes a specified RestApi callable over the internet.
- CreateDocumentationPart ( array $params = [] )
- Creates a documentation part.
- CreateDocumentationVersion ( array $params = [] )
- Creates a documentation version
- CreateDomainName ( array $params = [] )
- Creates a new domain name.
- CreateDomainNameAccessAssociation ( array $params = [] )
- Creates a domain name access association resource between an access association source and a private custom domain name.
- CreateModel ( array $params = [] )
- Adds a new Model resource to an existing RestApi resource.
- CreateRequestValidator ( array $params = [] )
- Creates a RequestValidator of a given RestApi.
- CreateResource ( array $params = [] )
- Creates a Resource resource.
- CreateRestApi ( array $params = [] )
- Creates a new RestApi resource.
- CreateStage ( array $params = [] )
- Creates a new Stage resource that references a pre-existing Deployment for the API.
- CreateUsagePlan ( array $params = [] )
- Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
- CreateUsagePlanKey ( array $params = [] )
- Creates a usage plan key for adding an existing API key to a usage plan.
- CreateVpcLink ( array $params = [] )
- 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.
- DeleteApiKey ( array $params = [] )
- Deletes the ApiKey resource.
- DeleteAuthorizer ( array $params = [] )
- Deletes an existing Authorizer resource.
- DeleteBasePathMapping ( array $params = [] )
- Deletes the BasePathMapping resource.
- DeleteClientCertificate ( array $params = [] )
- Deletes the ClientCertificate resource.
- DeleteDeployment ( array $params = [] )
- Deletes a Deployment resource.
- DeleteDocumentationPart ( array $params = [] )
- Deletes a documentation part
- DeleteDocumentationVersion ( array $params = [] )
- Deletes a documentation version.
- DeleteDomainName ( array $params = [] )
- Deletes the DomainName resource.
- DeleteDomainNameAccessAssociation ( array $params = [] )
- Deletes the DomainNameAccessAssociation resource.
- DeleteGatewayResponse ( array $params = [] )
- Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
- DeleteIntegration ( array $params = [] )
- Represents a delete integration.
- DeleteIntegrationResponse ( array $params = [] )
- Represents a delete integration response.
- DeleteMethod ( array $params = [] )
- Deletes an existing Method resource.
- DeleteMethodResponse ( array $params = [] )
- Deletes an existing MethodResponse resource.
- DeleteModel ( array $params = [] )
- Deletes a model.
- DeleteRequestValidator ( array $params = [] )
- Deletes a RequestValidator of a given RestApi.
- DeleteResource ( array $params = [] )
- Deletes a Resource resource.
- DeleteRestApi ( array $params = [] )
- Deletes the specified API.
- DeleteStage ( array $params = [] )
- Deletes a Stage resource.
- DeleteUsagePlan ( array $params = [] )
- Deletes a usage plan of a given plan Id.
- DeleteUsagePlanKey ( array $params = [] )
- Deletes a usage plan key and remove the underlying API key from the associated usage plan.
- DeleteVpcLink ( array $params = [] )
- Deletes an existing VpcLink of a specified identifier.
- FlushStageAuthorizersCache ( array $params = [] )
- Flushes all authorizer cache entries on a stage.
- FlushStageCache ( array $params = [] )
- Flushes a stage's cache.
- GenerateClientCertificate ( array $params = [] )
- Generates a ClientCertificate resource.
- GetAccount ( array $params = [] )
- Gets information about the current Account resource.
- GetApiKey ( array $params = [] )
- Gets information about the current ApiKey resource.
- GetApiKeys ( array $params = [] )
- Gets information about the current ApiKeys resource.
- GetAuthorizer ( array $params = [] )
- Describe an existing Authorizer resource.
- GetAuthorizers ( array $params = [] )
- Describe an existing Authorizers resource.
- GetBasePathMapping ( array $params = [] )
- Describe a BasePathMapping resource.
- GetBasePathMappings ( array $params = [] )
- Represents a collection of BasePathMapping resources.
- GetClientCertificate ( array $params = [] )
- Gets information about the current ClientCertificate resource.
- GetClientCertificates ( array $params = [] )
- Gets a collection of ClientCertificate resources.
- GetDeployment ( array $params = [] )
- Gets information about a Deployment resource.
- GetDeployments ( array $params = [] )
- Gets information about a Deployments collection.
- GetDocumentationPart ( array $params = [] )
- Gets a documentation part.
- GetDocumentationParts ( array $params = [] )
- Gets documentation parts.
- GetDocumentationVersion ( array $params = [] )
- Gets a documentation version.
- GetDocumentationVersions ( array $params = [] )
- Gets documentation versions.
- GetDomainName ( array $params = [] )
- Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
- GetDomainNameAccessAssociations ( array $params = [] )
- Represents a collection on DomainNameAccessAssociations resources.
- GetDomainNames ( array $params = [] )
- Represents a collection of DomainName resources.
- GetExport ( array $params = [] )
- Exports a deployed version of a RestApi in a specified format.
- GetGatewayResponse ( array $params = [] )
- Gets a GatewayResponse of a specified response type on the given RestApi.
- GetGatewayResponses ( array $params = [] )
- Gets the GatewayResponses collection on the given RestApi.
- GetIntegration ( array $params = [] )
- Get the integration settings.
- GetIntegrationResponse ( array $params = [] )
- Represents a get integration response.
- GetMethod ( array $params = [] )
- Describe an existing Method resource.
- GetMethodResponse ( array $params = [] )
- Describes a MethodResponse resource.
- GetModel ( array $params = [] )
- Describes an existing model defined for a RestApi resource.
- GetModelTemplate ( array $params = [] )
- Generates a sample mapping template that can be used to transform a payload into the structure of a model.
- GetModels ( array $params = [] )
- Describes existing Models defined for a RestApi resource.
- GetRequestValidator ( array $params = [] )
- Gets a RequestValidator of a given RestApi.
- GetRequestValidators ( array $params = [] )
- Gets the RequestValidators collection of a given RestApi.
- GetResource ( array $params = [] )
- Lists information about a resource.
- GetResources ( array $params = [] )
- Lists information about a collection of Resource resources.
- GetRestApi ( array $params = [] )
- Lists the RestApi resource in the collection.
- GetRestApis ( array $params = [] )
- Lists the RestApis resources for your collection.
- GetSdk ( array $params = [] )
- Generates a client SDK for a RestApi and Stage.
- GetSdkType ( array $params = [] )
- Gets an SDK type.
- GetSdkTypes ( array $params = [] )
- Gets SDK types
- GetStage ( array $params = [] )
- Gets information about a Stage resource.
- GetStages ( array $params = [] )
- Gets information about one or more Stage resources.
- GetTags ( array $params = [] )
- Gets the Tags collection for a given resource.
- GetUsage ( array $params = [] )
- Gets the usage data of a usage plan in a specified time interval.
- GetUsagePlan ( array $params = [] )
- Gets a usage plan of a given plan identifier.
- GetUsagePlanKey ( array $params = [] )
- Gets a usage plan key of a given key identifier.
- GetUsagePlanKeys ( array $params = [] )
- Gets all the usage plan keys representing the API keys added to a specified usage plan.
- GetUsagePlans ( array $params = [] )
- Gets all the usage plans of the caller's account.
- GetVpcLink ( array $params = [] )
- Gets a specified VPC link under the caller's account in a region.
- GetVpcLinks ( array $params = [] )
- Gets the VpcLinks collection under the caller's account in a selected region.
- ImportApiKeys ( array $params = [] )
- Import API keys from an external source, such as a CSV-formatted file.
- ImportDocumentationParts ( array $params = [] )
- Imports documentation parts
- ImportRestApi ( array $params = [] )
- A feature of the API Gateway control service for creating a new API from an external API definition file.
- PutGatewayResponse ( array $params = [] )
- Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
- PutIntegration ( array $params = [] )
- Sets up a method's integration.
- PutIntegrationResponse ( array $params = [] )
- Represents a put integration.
- PutMethod ( array $params = [] )
- Add a method to an existing Resource resource.
- PutMethodResponse ( array $params = [] )
- Adds a MethodResponse to an existing Method resource.
- PutRestApi ( array $params = [] )
- A feature of the API Gateway control service for updating an existing API with an input of external API definitions.
- RejectDomainNameAccessAssociation ( array $params = [] )
- Rejects a domain name access association with a private custom domain name.
- TagResource ( array $params = [] )
- Adds or updates a tag on a given resource.
- TestInvokeAuthorizer ( array $params = [] )
- Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
- TestInvokeMethod ( array $params = [] )
- Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
- UntagResource ( array $params = [] )
- Removes a tag from a given resource.
- UpdateAccount ( array $params = [] )
- Changes information about the current Account resource.
- UpdateApiKey ( array $params = [] )
- Changes information about an ApiKey resource.
- UpdateAuthorizer ( array $params = [] )
- Updates an existing Authorizer resource.
- UpdateBasePathMapping ( array $params = [] )
- Changes information about the BasePathMapping resource.
- UpdateClientCertificate ( array $params = [] )
- Changes information about an ClientCertificate resource.
- UpdateDeployment ( array $params = [] )
- Changes information about a Deployment resource.
- UpdateDocumentationPart ( array $params = [] )
- Updates a documentation part.
- UpdateDocumentationVersion ( array $params = [] )
- Updates a documentation version.
- UpdateDomainName ( array $params = [] )
- Changes information about the DomainName resource.
- UpdateGatewayResponse ( array $params = [] )
- Updates a GatewayResponse of a specified response type on the given RestApi.
- UpdateIntegration ( array $params = [] )
- Represents an update integration.
- UpdateIntegrationResponse ( array $params = [] )
- Represents an update integration response.
- UpdateMethod ( array $params = [] )
- Updates an existing Method resource.
- UpdateMethodResponse ( array $params = [] )
- Updates an existing MethodResponse resource.
- UpdateModel ( array $params = [] )
- Changes information about a model.
- UpdateRequestValidator ( array $params = [] )
- Updates a RequestValidator of a given RestApi.
- UpdateResource ( array $params = [] )
- Changes information about a Resource resource.
- UpdateRestApi ( array $params = [] )
- Changes information about the specified API.
- UpdateStage ( array $params = [] )
- Changes information about a Stage resource.
- UpdateUsage ( array $params = [] )
- Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
- UpdateUsagePlan ( array $params = [] )
- Updates a usage plan of a given plan Id.
- UpdateVpcLink ( array $params = [] )
- Updates an existing VpcLink of a specified identifier.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- GetApiKeys
- GetBasePathMappings
- GetClientCertificates
- GetDeployments
- GetDomainNames
- GetModels
- GetResources
- GetRestApis
- GetUsage
- GetUsagePlanKeys
- GetUsagePlans
- GetVpcLinks
Operations
CreateApiKey
$result = $client->createApiKey
([/* ... */]); $promise = $client->createApiKeyAsync
([/* ... */]);
Create an ApiKey resource.
Parameter Syntax
$result = $client->createApiKey([ 'customerId' => '<string>', 'description' => '<string>', 'enabled' => true || false, 'generateDistinctId' => true || false, 'name' => '<string>', 'stageKeys' => [ [ 'restApiId' => '<string>', 'stageName' => '<string>', ], // ... ], 'tags' => ['<string>', ...], 'value' => '<string>', ]);
Parameter Details
Members
- customerId
-
- Type: string
An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
- description
-
- Type: string
The description of the ApiKey.
- enabled
-
- Type: boolean
Specifies whether the ApiKey can be used by callers.
- generateDistinctId
-
- Type: boolean
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. - name
-
- Type: string
The name of the ApiKey.
- stageKeys
-
- Type: Array of StageKey structures
DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters. - value
-
- Type: string
Specifies a value of the API key.
Result Syntax
[ 'createdDate' => <DateTime>, 'customerId' => '<string>', 'description' => '<string>', 'enabled' => true || false, 'id' => '<string>', 'lastUpdatedDate' => <DateTime>, 'name' => '<string>', 'stageKeys' => ['<string>', ...], 'tags' => ['<string>', ...], 'value' => '<string>', ]
Result Details
Members
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the API Key was created.
- customerId
-
- Type: string
An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
- description
-
- Type: string
The description of the API Key.
- enabled
-
- Type: boolean
Specifies whether the API Key can be used by callers.
- id
-
- Type: string
The identifier of the API Key.
- lastUpdatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the API Key was last updated.
- name
-
- Type: string
The name of the API Key.
- stageKeys
-
- Type: Array of strings
A list of Stage resources that are associated with the ApiKey resource.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- value
-
- Type: string
The value of the API Key.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateAuthorizer
$result = $client->createAuthorizer
([/* ... */]); $promise = $client->createAuthorizerAsync
([/* ... */]);
Adds a new Authorizer resource to an existing RestApi resource.
Parameter Syntax
$result = $client->createAuthorizer([ 'authType' => '<string>', 'authorizerCredentials' => '<string>', 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'identitySource' => '<string>', 'identityValidationExpression' => '<string>', 'name' => '<string>', // REQUIRED 'providerARNs' => ['<string>', ...], 'restApiId' => '<string>', // REQUIRED 'type' => 'TOKEN|REQUEST|COGNITO_USER_POOLS', // REQUIRED ]);
Parameter Details
Members
- authType
-
- Type: string
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
- authorizerCredentials
-
- Type: string
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.
- authorizerResultTtlInSeconds
-
- Type: int
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.
- authorizerUri
-
- Type: string
Specifies the authorizer's Uniform Resource Identifier (URI). For
TOKEN
orREQUEST
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 formarn: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
. - identitySource
-
- Type: string
The identity source for which authorization is requested. For a
TOKEN
orCOGNITO_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 isAuth
, the header mapping expression ismethod.request.header.Auth
. For theREQUEST
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 anAuth
header, aName
query string parameter are defined as identity sources, this value ismethod.request.header.Auth, method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional. - identityValidationExpression
-
- Type: string
A validation expression for the incoming identity token. For
TOKEN
authorizers, this value is a regular expression. ForCOGNITO_USER_POOLS
authorizers, API Gateway will match theaud
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 theREQUEST
authorizer. - name
-
- Required: Yes
- Type: string
The name of the authorizer.
- providerARNs
-
- Type: Array of strings
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 aTOKEN
orREQUEST
authorizer, this is not defined. - restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- type
-
- Required: Yes
- Type: string
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, andCOGNITO_USER_POOLS
for using an Amazon Cognito user pool.
Result Syntax
[ 'authType' => '<string>', 'authorizerCredentials' => '<string>', 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'id' => '<string>', 'identitySource' => '<string>', 'identityValidationExpression' => '<string>', 'name' => '<string>', 'providerARNs' => ['<string>', ...], 'type' => 'TOKEN|REQUEST|COGNITO_USER_POOLS', ]
Result Details
Members
- authType
-
- Type: string
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
- authorizerCredentials
-
- Type: string
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.
- authorizerResultTtlInSeconds
-
- Type: int
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.
- authorizerUri
-
- Type: string
Specifies the authorizer's Uniform Resource Identifier (URI). For
TOKEN
orREQUEST
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 formarn: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
. - id
-
- Type: string
The identifier for the authorizer resource.
- identitySource
-
- Type: string
The identity source for which authorization is requested. For a
TOKEN
orCOGNITO_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 isAuth
, the header mapping expression ismethod.request.header.Auth
. For theREQUEST
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 anAuth
header, aName
query string parameter are defined as identity sources, this value ismethod.request.header.Auth
,method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional. - identityValidationExpression
-
- Type: string
A validation expression for the incoming identity token. For
TOKEN
authorizers, this value is a regular expression. ForCOGNITO_USER_POOLS
authorizers, API Gateway will match theaud
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 theREQUEST
authorizer. - name
-
- Type: string
The name of the authorizer.
- providerARNs
-
- Type: Array of strings
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 aTOKEN
orREQUEST
authorizer, this is not defined. - type
-
- Type: string
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, andCOGNITO_USER_POOLS
for using an Amazon Cognito user pool.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateBasePathMapping
$result = $client->createBasePathMapping
([/* ... */]); $promise = $client->createBasePathMappingAsync
([/* ... */]);
Creates a new BasePathMapping resource.
Parameter Syntax
$result = $client->createBasePathMapping([ 'basePath' => '<string>', 'domainName' => '<string>', // REQUIRED 'domainNameId' => '<string>', 'restApiId' => '<string>', // REQUIRED 'stage' => '<string>', ]);
Parameter Details
Members
- basePath
-
- Type: string
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.
- domainName
-
- Required: Yes
- Type: string
The domain name of the BasePathMapping resource to create.
- domainNameId
-
- Type: string
The identifier for the domain name resource. Supported only for private custom domain names.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- stage
-
- Type: string
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.
Result Syntax
[ 'basePath' => '<string>', 'restApiId' => '<string>', 'stage' => '<string>', ]
Result Details
Members
- basePath
-
- Type: string
The base path name that callers of the API must provide as part of the URL after the domain name.
- restApiId
-
- Type: string
The string identifier of the associated RestApi.
- stage
-
- Type: string
The name of the associated stage.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateDeployment
$result = $client->createDeployment
([/* ... */]); $promise = $client->createDeploymentAsync
([/* ... */]);
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
Parameter Syntax
$result = $client->createDeployment([ 'cacheClusterEnabled' => true || false, 'cacheClusterSize' => '0.5|1.6|6.1|13.5|28.4|58.2|118|237', 'canarySettings' => [ 'percentTraffic' => <float>, 'stageVariableOverrides' => ['<string>', ...], 'useStageCache' => true || false, ], 'description' => '<string>', 'restApiId' => '<string>', // REQUIRED 'stageDescription' => '<string>', 'stageName' => '<string>', 'tracingEnabled' => true || false, 'variables' => ['<string>', ...], ]);
Parameter Details
Members
- cacheClusterEnabled
-
- Type: boolean
Enables a cache cluster for the Stage resource specified in the input.
- cacheClusterSize
-
- Type: string
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
- canarySettings
-
- Type: DeploymentCanarySettings structure
The input configuration for the canary deployment when the deployment is a canary release deployment.
- description
-
- Type: string
The description for the Deployment resource to create.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- stageDescription
-
- Type: string
The description of the Stage resource for the Deployment resource to create.
- stageName
-
- Type: string
The name of the Stage resource for the Deployment resource to create.
- tracingEnabled
-
- Type: boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
- variables
-
- Type: Associative array of custom strings keys (String) to strings
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-._~:/?#&=,]+
.
Result Syntax
[ 'apiSummary' => [ '<String>' => [ '<String>' => [ 'apiKeyRequired' => true || false, 'authorizationType' => '<string>', ], // ... ], // ... ], 'createdDate' => <DateTime>, 'description' => '<string>', 'id' => '<string>', ]
Result Details
Members
- apiSummary
-
- Type: Associative array of custom strings keys (String) to MethodSnapshot structuress
A summary of the RestApi at the date and time that the deployment resource was created.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the deployment resource was created.
- description
-
- Type: string
The description for the deployment resource.
- id
-
- Type: string
The identifier for the deployment resource.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
- ServiceUnavailableException:
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
CreateDocumentationPart
$result = $client->createDocumentationPart
([/* ... */]); $promise = $client->createDocumentationPartAsync
([/* ... */]);
Creates a documentation part.
Parameter Syntax
$result = $client->createDocumentationPart([ 'location' => [ // REQUIRED 'method' => '<string>', 'name' => '<string>', 'path' => '<string>', 'statusCode' => '<string>', 'type' => 'API|AUTHORIZER|MODEL|RESOURCE|METHOD|PATH_PARAMETER|QUERY_PARAMETER|REQUEST_HEADER|REQUEST_BODY|RESPONSE|RESPONSE_HEADER|RESPONSE_BODY', // REQUIRED ], 'properties' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- location
-
- Required: Yes
- Type: DocumentationPartLocation structure
The location of the targeted API entity of the to-be-created documentation part.
- properties
-
- Required: Yes
- Type: string
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.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'id' => '<string>', 'location' => [ 'method' => '<string>', 'name' => '<string>', 'path' => '<string>', 'statusCode' => '<string>', 'type' => 'API|AUTHORIZER|MODEL|RESOURCE|METHOD|PATH_PARAMETER|QUERY_PARAMETER|REQUEST_HEADER|REQUEST_BODY|RESPONSE|RESPONSE_HEADER|RESPONSE_BODY', ], 'properties' => '<string>', ]
Result Details
Members
- id
-
- Type: string
The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart
is created. - location
-
- Type: DocumentationPartLocation structure
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.
- properties
-
- Type: string
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 ofx-amazon-apigateway-documentation
.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateDocumentationVersion
$result = $client->createDocumentationVersion
([/* ... */]); $promise = $client->createDocumentationVersionAsync
([/* ... */]);
Creates a documentation version
Parameter Syntax
$result = $client->createDocumentationVersion([ 'description' => '<string>', 'documentationVersion' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED 'stageName' => '<string>', ]);
Parameter Details
Members
- description
-
- Type: string
A description about the new documentation snapshot.
- documentationVersion
-
- Required: Yes
- Type: string
The version identifier of the new snapshot.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- stageName
-
- Type: string
The stage name to be associated with the new documentation snapshot.
Result Syntax
[ 'createdDate' => <DateTime>, 'description' => '<string>', 'version' => '<string>', ]
Result Details
Members
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date when the API documentation snapshot is created.
- description
-
- Type: string
The description of the API documentation snapshot.
- version
-
- Type: string
The version identifier of the API documentation snapshot.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateDomainName
$result = $client->createDomainName
([/* ... */]); $promise = $client->createDomainNameAsync
([/* ... */]);
Creates a new domain name.
Parameter Syntax
$result = $client->createDomainName([ 'certificateArn' => '<string>', 'certificateBody' => '<string>', 'certificateChain' => '<string>', 'certificateName' => '<string>', 'certificatePrivateKey' => '<string>', 'domainName' => '<string>', // REQUIRED 'endpointConfiguration' => [ 'types' => ['<string>', ...], 'vpcEndpointIds' => ['<string>', ...], ], 'mutualTlsAuthentication' => [ 'truststoreUri' => '<string>', 'truststoreVersion' => '<string>', ], 'ownershipVerificationCertificateArn' => '<string>', 'policy' => '<string>', 'regionalCertificateArn' => '<string>', 'regionalCertificateName' => '<string>', 'securityPolicy' => 'TLS_1_0|TLS_1_2', 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- certificateArn
-
- Type: string
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.
- certificateBody
-
- Type: string
[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.
- certificateChain
-
- Type: string
[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.
- certificateName
-
- Type: string
The user-friendly name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
- certificatePrivateKey
-
- Type: string
[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
- domainName
-
- Required: Yes
- Type: string
The name of the DomainName resource.
- endpointConfiguration
-
- Type: EndpointConfiguration structure
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
- mutualTlsAuthentication
-
- Type: MutualTlsAuthenticationInput structure
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.
- ownershipVerificationCertificateArn
-
- Type: string
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.
- policy
-
- Type: string
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. - regionalCertificateArn
-
- Type: string
The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.
- regionalCertificateName
-
- Type: string
The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
- securityPolicy
-
- Type: string
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
. - tags
-
- Type: Associative array of custom strings keys (String) to strings
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters.
Result Syntax
[ 'certificateArn' => '<string>', 'certificateName' => '<string>', 'certificateUploadDate' => <DateTime>, 'distributionDomainName' => '<string>', 'distributionHostedZoneId' => '<string>', 'domainName' => '<string>', 'domainNameArn' => '<string>', 'domainNameId' => '<string>', 'domainNameStatus' => 'AVAILABLE|UPDATING|PENDING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION', 'domainNameStatusMessage' => '<string>', 'endpointConfiguration' => [ '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>', 'securityPolicy' => 'TLS_1_0|TLS_1_2', 'tags' => ['<string>', ...], ]
Result Details
Members
- certificateArn
-
- Type: string
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.
- certificateName
-
- Type: string
The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
- certificateUploadDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.
- distributionDomainName
-
- Type: string
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.
- distributionHostedZoneId
-
- Type: string
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. - domainName
-
- Type: string
The custom domain name as an API host name, for example,
my-api.example.com
. - domainNameArn
-
- Type: string
The ARN of the domain name. Supported only for private custom domain names.
- domainNameId
-
- Type: string
The identifier for the domain name resource. Supported only for private custom domain names.
- domainNameStatus
-
- Type: string
The status of the DomainName migration. The valid values are
AVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, the domain can be updated. - domainNameStatusMessage
-
- Type: string
An optional text message containing detailed information about status of the DomainName migration.
- endpointConfiguration
-
- Type: EndpointConfiguration structure
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
- managementPolicy
-
- Type: string
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.
- mutualTlsAuthentication
-
- Type: MutualTlsAuthentication structure
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.
- ownershipVerificationCertificateArn
-
- Type: string
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.
- policy
-
- Type: string
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. - regionalCertificateArn
-
- Type: string
The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
- regionalCertificateName
-
- Type: string
The name of the certificate that will be used for validating the regional domain name.
- regionalDomainName
-
- Type: string
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.
- regionalHostedZoneId
-
- Type: string
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.
- securityPolicy
-
- Type: string
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
. - tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateDomainNameAccessAssociation
$result = $client->createDomainNameAccessAssociation
([/* ... */]); $promise = $client->createDomainNameAccessAssociationAsync
([/* ... */]);
Creates a domain name access association resource between an access association source and a private custom domain name.
Parameter Syntax
$result = $client->createDomainNameAccessAssociation([ 'accessAssociationSource' => '<string>', // REQUIRED 'accessAssociationSourceType' => 'VPCE', // REQUIRED 'domainNameArn' => '<string>', // REQUIRED 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- accessAssociationSource
-
- Required: Yes
- Type: string
The identifier of the domain name access association source. For a VPCE, the value is the VPC endpoint ID.
- accessAssociationSourceType
-
- Required: Yes
- Type: string
The type of the domain name access association source.
- domainNameArn
-
- Required: Yes
- Type: string
The ARN of the domain name.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters.
Result Syntax
[ 'accessAssociationSource' => '<string>', 'accessAssociationSourceType' => 'VPCE', 'domainNameAccessAssociationArn' => '<string>', 'domainNameArn' => '<string>', 'tags' => ['<string>', ...], ]
Result Details
Members
- accessAssociationSource
-
- Type: string
The ARN of the domain name access association source. For a VPCE, the ARN must be a VPC endpoint.
- accessAssociationSourceType
-
- Type: string
The type of the domain name access association source.
- domainNameAccessAssociationArn
-
- Type: string
The ARN of the domain name access association resource.
- domainNameArn
-
- Type: string
The ARN of the domain name.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateModel
$result = $client->createModel
([/* ... */]); $promise = $client->createModelAsync
([/* ... */]);
Adds a new Model resource to an existing RestApi resource.
Parameter Syntax
$result = $client->createModel([ 'contentType' => '<string>', // REQUIRED 'description' => '<string>', 'name' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED 'schema' => '<string>', ]);
Parameter Details
Members
- contentType
-
- Required: Yes
- Type: string
The content-type for the model.
- description
-
- Type: string
The description of the model.
- name
-
- Required: Yes
- Type: string
The name of the model. Must be alphanumeric.
- restApiId
-
- Required: Yes
- Type: string
The RestApi identifier under which the Model will be created.
- schema
-
- Type: string
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.
Result Syntax
[ 'contentType' => '<string>', 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'schema' => '<string>', ]
Result Details
Members
- contentType
-
- Type: string
The content-type for the model.
- description
-
- Type: string
The description of the model.
- id
-
- Type: string
The identifier for the model resource.
- name
-
- Type: string
The name of the model. Must be an alphanumeric string.
- schema
-
- Type: string
The schema for the model. For
application/json
models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateRequestValidator
$result = $client->createRequestValidator
([/* ... */]); $promise = $client->createRequestValidatorAsync
([/* ... */]);
Creates a RequestValidator of a given RestApi.
Parameter Syntax
$result = $client->createRequestValidator([ 'name' => '<string>', 'restApiId' => '<string>', // REQUIRED 'validateRequestBody' => true || false, 'validateRequestParameters' => true || false, ]);
Parameter Details
Members
- name
-
- Type: string
The name of the to-be-created RequestValidator.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- validateRequestBody
-
- Type: boolean
A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (
true
) or not (false
). - validateRequestParameters
-
- Type: boolean
A Boolean flag to indicate whether to validate request parameters,
true
, or notfalse
.
Result Syntax
[ 'id' => '<string>', 'name' => '<string>', 'validateRequestBody' => true || false, 'validateRequestParameters' => true || false, ]
Result Details
Members
- id
-
- Type: string
The identifier of this RequestValidator.
- name
-
- Type: string
The name of this RequestValidator
- validateRequestBody
-
- Type: boolean
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
- validateRequestParameters
-
- Type: boolean
A Boolean flag to indicate whether to validate request parameters (
true
) or not (false
).
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateResource
$result = $client->createResource
([/* ... */]); $promise = $client->createResourceAsync
([/* ... */]);
Creates a Resource resource.
Parameter Syntax
$result = $client->createResource([ 'parentId' => '<string>', // REQUIRED 'pathPart' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- parentId
-
- Required: Yes
- Type: string
The parent resource's identifier.
- pathPart
-
- Required: Yes
- Type: string
The last path segment for this resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'id' => '<string>', 'parentId' => '<string>', 'path' => '<string>', 'pathPart' => '<string>', 'resourceMethods' => [ '<String>' => [ 'apiKeyRequired' => true || false, 'authorizationScopes' => ['<string>', ...], 'authorizationType' => '<string>', 'authorizerId' => '<string>', 'httpMethod' => '<string>', 'methodIntegration' => [ 'cacheKeyParameters' => ['<string>', ...], 'cacheNamespace' => '<string>', 'connectionId' => '<string>', 'connectionType' => 'INTERNET|VPC_LINK', 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'credentials' => '<string>', 'httpMethod' => '<string>', 'integrationResponses' => [ '<String>' => [ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ], // ... ], 'passthroughBehavior' => '<string>', 'requestParameters' => ['<string>', ...], 'requestTemplates' => ['<string>', ...], 'timeoutInMillis' => <integer>, 'tlsConfig' => [ 'insecureSkipVerification' => true || false, ], 'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY', 'uri' => '<string>', ], 'methodResponses' => [ '<String>' => [ 'responseModels' => ['<string>', ...], 'responseParameters' => [true || false, ...], 'statusCode' => '<string>', ], // ... ], 'operationName' => '<string>', 'requestModels' => ['<string>', ...], 'requestParameters' => [true || false, ...], 'requestValidatorId' => '<string>', ], // ... ], ]
Result Details
Members
- id
-
- Type: string
The resource's identifier.
- parentId
-
- Type: string
The parent resource's identifier.
- path
-
- Type: string
The full path for this resource.
- pathPart
-
- Type: string
The last path segment for this resource.
- resourceMethods
-
- Type: Associative array of custom strings keys (String) to Method structures
Gets an API resource's method of a given HTTP verb.
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateRestApi
$result = $client->createRestApi
([/* ... */]); $promise = $client->createRestApiAsync
([/* ... */]);
Creates a new RestApi resource.
Parameter Syntax
$result = $client->createRestApi([ 'apiKeySource' => 'HEADER|AUTHORIZER', 'binaryMediaTypes' => ['<string>', ...], 'cloneFrom' => '<string>', 'description' => '<string>', 'disableExecuteApiEndpoint' => true || false, 'endpointConfiguration' => [ 'types' => ['<string>', ...], 'vpcEndpointIds' => ['<string>', ...], ], 'minimumCompressionSize' => <integer>, 'name' => '<string>', // REQUIRED 'policy' => '<string>', 'tags' => ['<string>', ...], 'version' => '<string>', ]);
Parameter Details
Members
- apiKeySource
-
- Type: string
The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer. - binaryMediaTypes
-
- Type: Array of strings
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- cloneFrom
-
- Type: string
The ID of the RestApi that you want to clone from.
- description
-
- Type: string
The description of the RestApi.
- disableExecuteApiEndpoint
-
- Type: boolean
Specifies whether clients can invoke your API by using the default
execute-api
endpoint. By default, clients can invoke your API with the defaulthttps://{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 - endpointConfiguration
-
- Type: EndpointConfiguration structure
The endpoint configuration of this RestApi showing the endpoint types of the API.
- minimumCompressionSize
-
- Type: int
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.
- name
-
- Required: Yes
- Type: string
The name of the RestApi.
- policy
-
- Type: string
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters. - version
-
- Type: string
A version identifier for the API.
Result Syntax
[ 'apiKeySource' => 'HEADER|AUTHORIZER', 'binaryMediaTypes' => ['<string>', ...], 'createdDate' => <DateTime>, 'description' => '<string>', 'disableExecuteApiEndpoint' => true || false, 'endpointConfiguration' => [ 'types' => ['<string>', ...], 'vpcEndpointIds' => ['<string>', ...], ], 'id' => '<string>', 'minimumCompressionSize' => <integer>, 'name' => '<string>', 'policy' => '<string>', 'rootResourceId' => '<string>', 'tags' => ['<string>', ...], 'version' => '<string>', 'warnings' => ['<string>', ...], ]
Result Details
Members
- apiKeySource
-
- Type: string
The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer. - binaryMediaTypes
-
- Type: Array of strings
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the API was created.
- description
-
- Type: string
The API's description.
- disableExecuteApiEndpoint
-
- Type: boolean
Specifies whether clients can invoke your API by using the default
execute-api
endpoint. By default, clients can invoke your API with the defaulthttps://{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. - endpointConfiguration
-
- Type: EndpointConfiguration structure
The endpoint configuration of this RestApi showing the endpoint types of the API.
- id
-
- Type: string
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
- minimumCompressionSize
-
- Type: int
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.
- name
-
- Type: string
The API's name.
- policy
-
- Type: string
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
- rootResourceId
-
- Type: string
The API's root resource ID.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- version
-
- Type: string
A version identifier for the API.
- warnings
-
- Type: Array of strings
The warning messages reported when
failonwarnings
is turned on during API import.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateStage
$result = $client->createStage
([/* ... */]); $promise = $client->createStageAsync
([/* ... */]);
Creates a new Stage resource that references a pre-existing Deployment for the API.
Parameter Syntax
$result = $client->createStage([ 'cacheClusterEnabled' => true || false, 'cacheClusterSize' => '0.5|1.6|6.1|13.5|28.4|58.2|118|237', 'canarySettings' => [ 'deploymentId' => '<string>', 'percentTraffic' => <float>, 'stageVariableOverrides' => ['<string>', ...], 'useStageCache' => true || false, ], 'deploymentId' => '<string>', // REQUIRED 'description' => '<string>', 'documentationVersion' => '<string>', 'restApiId' => '<string>', // REQUIRED 'stageName' => '<string>', // REQUIRED 'tags' => ['<string>', ...], 'tracingEnabled' => true || false, 'variables' => ['<string>', ...], ]);
Parameter Details
Members
- cacheClusterEnabled
-
- Type: boolean
Whether cache clustering is enabled for the stage.
- cacheClusterSize
-
- Type: string
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
- canarySettings
-
- Type: CanarySettings structure
The canary deployment settings of this stage.
- deploymentId
-
- Required: Yes
- Type: string
The identifier of the Deployment resource for the Stage resource.
- description
-
- Type: string
The description of the Stage resource.
- documentationVersion
-
- Type: string
The version of the associated API documentation.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- stageName
-
- Required: Yes
- Type: string
The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters. - tracingEnabled
-
- Type: boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
- variables
-
- Type: Associative array of custom strings keys (String) to strings
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-._~:/?#&=,]+
.
Result Syntax
[ 'accessLogSettings' => [ 'destinationArn' => '<string>', 'format' => '<string>', ], 'cacheClusterEnabled' => true || false, 'cacheClusterSize' => '0.5|1.6|6.1|13.5|28.4|58.2|118|237', 'cacheClusterStatus' => 'CREATE_IN_PROGRESS|AVAILABLE|DELETE_IN_PROGRESS|NOT_AVAILABLE|FLUSH_IN_PROGRESS', 'canarySettings' => [ 'deploymentId' => '<string>', 'percentTraffic' => <float>, 'stageVariableOverrides' => ['<string>', ...], 'useStageCache' => true || false, ], 'clientCertificateId' => '<string>', 'createdDate' => <DateTime>, 'deploymentId' => '<string>', 'description' => '<string>', 'documentationVersion' => '<string>', 'lastUpdatedDate' => <DateTime>, 'methodSettings' => [ '<String>' => [ 'cacheDataEncrypted' => true || false, 'cacheTtlInSeconds' => <integer>, 'cachingEnabled' => true || false, 'dataTraceEnabled' => true || false, 'loggingLevel' => '<string>', 'metricsEnabled' => true || false, 'requireAuthorizationForCacheControl' => true || false, 'throttlingBurstLimit' => <integer>, 'throttlingRateLimit' => <float>, 'unauthorizedCacheControlHeaderStrategy' => 'FAIL_WITH_403|SUCCEED_WITH_RESPONSE_HEADER|SUCCEED_WITHOUT_RESPONSE_HEADER', ], // ... ], 'stageName' => '<string>', 'tags' => ['<string>', ...], 'tracingEnabled' => true || false, 'variables' => ['<string>', ...], 'webAclArn' => '<string>', ]
Result Details
Members
- accessLogSettings
-
- Type: AccessLogSettings structure
Settings for logging access in this stage.
- cacheClusterEnabled
-
- Type: boolean
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
totrue
for a method. - cacheClusterSize
-
- Type: string
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
- cacheClusterStatus
-
- Type: string
The status of the cache cluster for the stage, if enabled.
- canarySettings
-
- Type: CanarySettings structure
Settings for the canary deployment in this stage.
- clientCertificateId
-
- Type: string
The identifier of a client certificate for an API stage.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the stage was created.
- deploymentId
-
- Type: string
The identifier of the Deployment that the stage points to.
- description
-
- Type: string
The stage's description.
- documentationVersion
-
- Type: string
The version of the associated API documentation.
- lastUpdatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the stage last updated.
- methodSettings
-
- Type: Associative array of custom strings keys (String) to MethodSetting structures
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. - stageName
-
- Type: string
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.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- tracingEnabled
-
- Type: boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
- variables
-
- Type: Associative array of custom strings keys (String) to strings
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-._~:/?#&=,]+
. - webAclArn
-
- Type: string
The ARN of the WebAcl associated with the Stage.
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateUsagePlan
$result = $client->createUsagePlan
([/* ... */]); $promise = $client->createUsagePlanAsync
([/* ... */]);
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
Parameter Syntax
$result = $client->createUsagePlan([ 'apiStages' => [ [ 'apiId' => '<string>', 'stage' => '<string>', 'throttle' => [ '<String>' => [ 'burstLimit' => <integer>, 'rateLimit' => <float>, ], // ... ], ], // ... ], 'description' => '<string>', 'name' => '<string>', // REQUIRED 'quota' => [ 'limit' => <integer>, 'offset' => <integer>, 'period' => 'DAY|WEEK|MONTH', ], 'tags' => ['<string>', ...], 'throttle' => [ 'burstLimit' => <integer>, 'rateLimit' => <float>, ], ]);
Parameter Details
Members
- apiStages
-
- Type: Array of ApiStage structures
The associated API stages of the usage plan.
- description
-
- Type: string
The description of the usage plan.
- name
-
- Required: Yes
- Type: string
The name of the usage plan.
- quota
-
- Type: QuotaSettings structure
The quota of the usage plan.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters. - throttle
-
- Type: ThrottleSettings structure
The throttling limits of the usage plan.
Result Syntax
[ 'apiStages' => [ [ 'apiId' => '<string>', 'stage' => '<string>', 'throttle' => [ '<String>' => [ 'burstLimit' => <integer>, 'rateLimit' => <float>, ], // ... ], ], // ... ], 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'productCode' => '<string>', 'quota' => [ 'limit' => <integer>, 'offset' => <integer>, 'period' => 'DAY|WEEK|MONTH', ], 'tags' => ['<string>', ...], 'throttle' => [ 'burstLimit' => <integer>, 'rateLimit' => <float>, ], ]
Result Details
Members
- apiStages
-
- Type: Array of ApiStage structures
The associated API stages of a usage plan.
- description
-
- Type: string
The description of a usage plan.
- id
-
- Type: string
The identifier of a UsagePlan resource.
- name
-
- Type: string
The name of a usage plan.
- productCode
-
- Type: string
The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
- quota
-
- Type: QuotaSettings structure
The target maximum number of permitted requests per a given unit time interval.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- throttle
-
- Type: ThrottleSettings structure
A map containing method level throttling information for API stage in a usage plan.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateUsagePlanKey
$result = $client->createUsagePlanKey
([/* ... */]); $promise = $client->createUsagePlanKeyAsync
([/* ... */]);
Creates a usage plan key for adding an existing API key to a usage plan.
Parameter Syntax
$result = $client->createUsagePlanKey([ 'keyId' => '<string>', // REQUIRED 'keyType' => '<string>', // REQUIRED 'usagePlanId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- keyId
-
- Required: Yes
- Type: string
The identifier of a UsagePlanKey resource for a plan customer.
- keyType
-
- Required: Yes
- Type: string
The type of a UsagePlanKey resource for a plan customer.
- usagePlanId
-
- Required: Yes
- Type: string
The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.
Result Syntax
[ 'id' => '<string>', 'name' => '<string>', 'type' => '<string>', 'value' => '<string>', ]
Result Details
Members
- id
-
- Type: string
The Id of a usage plan key.
- name
-
- Type: string
The name of a usage plan key.
- type
-
- Type: string
The type of a usage plan key. Currently, the valid key type is
API_KEY
. - value
-
- Type: string
The value of a usage plan key.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
CreateVpcLink
$result = $client->createVpcLink
([/* ... */]); $promise = $client->createVpcLinkAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createVpcLink([ 'description' => '<string>', 'name' => '<string>', // REQUIRED 'tags' => ['<string>', ...], 'targetArns' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- description
-
- Type: string
The description of the VPC link.
- name
-
- Required: Yes
- Type: string
The name used to label and identify the VPC link.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters. - targetArns
-
- Required: Yes
- Type: Array of strings
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 Amazon Web Services account of the API owner.
Result Syntax
[ 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'status' => 'AVAILABLE|PENDING|DELETING|FAILED', 'statusMessage' => '<string>', 'tags' => ['<string>', ...], 'targetArns' => ['<string>', ...], ]
Result Details
Members
- description
-
- Type: string
The description of the VPC link.
- id
-
- Type: string
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
- name
-
- Type: string
The name used to label and identify the VPC link.
- status
-
- Type: string
The status of the VPC link. The valid values are
AVAILABLE
,PENDING
,DELETING
, orFAILED
. Deploying an API will wait if the status isPENDING
and will fail if the status isDELETING
. - statusMessage
-
- Type: string
A description about the VPC link status.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- targetArns
-
- Type: Array of strings
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 Amazon Web Services account of the API owner.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteApiKey
$result = $client->deleteApiKey
([/* ... */]); $promise = $client->deleteApiKeyAsync
([/* ... */]);
Deletes the ApiKey resource.
Parameter Syntax
$result = $client->deleteApiKey([ 'apiKey' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiKey
-
- Required: Yes
- Type: string
The identifier of the ApiKey resource to be deleted.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteAuthorizer
$result = $client->deleteAuthorizer
([/* ... */]); $promise = $client->deleteAuthorizerAsync
([/* ... */]);
Deletes an existing Authorizer resource.
Parameter Syntax
$result = $client->deleteAuthorizer([ 'authorizerId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- authorizerId
-
- Required: Yes
- Type: string
The identifier of the Authorizer resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteBasePathMapping
$result = $client->deleteBasePathMapping
([/* ... */]); $promise = $client->deleteBasePathMappingAsync
([/* ... */]);
Deletes the BasePathMapping resource.
Parameter Syntax
$result = $client->deleteBasePathMapping([ 'basePath' => '<string>', // REQUIRED 'domainName' => '<string>', // REQUIRED 'domainNameId' => '<string>', ]);
Parameter Details
Members
- basePath
-
- Required: Yes
- Type: string
The base path name of the BasePathMapping resource to delete.
To specify an empty base path, set this parameter to
'(none)'
. - domainName
-
- Required: Yes
- Type: string
The domain name of the BasePathMapping resource to delete.
- domainNameId
-
- Type: string
The identifier for the domain name resource. Supported only for private custom domain names.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteClientCertificate
$result = $client->deleteClientCertificate
([/* ... */]); $promise = $client->deleteClientCertificateAsync
([/* ... */]);
Deletes the ClientCertificate resource.
Parameter Syntax
$result = $client->deleteClientCertificate([ 'clientCertificateId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientCertificateId
-
- Required: Yes
- Type: string
The identifier of the ClientCertificate resource to be deleted.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteDeployment
$result = $client->deleteDeployment
([/* ... */]); $promise = $client->deleteDeploymentAsync
([/* ... */]);
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
Parameter Syntax
$result = $client->deleteDeployment([ 'deploymentId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- deploymentId
-
- Required: Yes
- Type: string
The identifier of the Deployment resource to delete.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteDocumentationPart
$result = $client->deleteDocumentationPart
([/* ... */]); $promise = $client->deleteDocumentationPartAsync
([/* ... */]);
Deletes a documentation part
Parameter Syntax
$result = $client->deleteDocumentationPart([ 'documentationPartId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- documentationPartId
-
- Required: Yes
- Type: string
The identifier of the to-be-deleted documentation part.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteDocumentationVersion
$result = $client->deleteDocumentationVersion
([/* ... */]); $promise = $client->deleteDocumentationVersionAsync
([/* ... */]);
Deletes a documentation version.
Parameter Syntax
$result = $client->deleteDocumentationVersion([ 'documentationVersion' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- documentationVersion
-
- Required: Yes
- Type: string
The version identifier of a to-be-deleted documentation snapshot.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteDomainName
$result = $client->deleteDomainName
([/* ... */]); $promise = $client->deleteDomainNameAsync
([/* ... */]);
Deletes the DomainName resource.
Parameter Syntax
$result = $client->deleteDomainName([ 'domainName' => '<string>', // REQUIRED 'domainNameId' => '<string>', ]);
Parameter Details
Members
- domainName
-
- Required: Yes
- Type: string
The name of the DomainName resource to be deleted.
- domainNameId
-
- Type: string
The identifier for the domain name resource. Supported only for private custom domain names.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteDomainNameAccessAssociation
$result = $client->deleteDomainNameAccessAssociation
([/* ... */]); $promise = $client->deleteDomainNameAccessAssociationAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteDomainNameAccessAssociation([ 'domainNameAccessAssociationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- domainNameAccessAssociationArn
-
- Required: Yes
- Type: string
The ARN of the domain name access association resource.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteGatewayResponse
$result = $client->deleteGatewayResponse
([/* ... */]); $promise = $client->deleteGatewayResponseAsync
([/* ... */]);
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
Parameter Syntax
$result = $client->deleteGatewayResponse([ 'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED|WAF_FILTERED', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- responseType
-
- Required: Yes
- Type: string
The response type of the associated GatewayResponse.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteIntegration
$result = $client->deleteIntegration
([/* ... */]); $promise = $client->deleteIntegrationAsync
([/* ... */]);
Represents a delete integration.
Parameter Syntax
$result = $client->deleteIntegration([ 'httpMethod' => '<string>', // REQUIRED 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
Specifies a delete integration request's HTTP method.
- resourceId
-
- Required: Yes
- Type: string
Specifies a delete integration request's resource identifier.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteIntegrationResponse
$result = $client->deleteIntegrationResponse
([/* ... */]); $promise = $client->deleteIntegrationResponseAsync
([/* ... */]);
Represents a delete integration response.
Parameter Syntax
$result = $client->deleteIntegrationResponse([ 'httpMethod' => '<string>', // REQUIRED 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED 'statusCode' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
Specifies a delete integration response request's HTTP method.
- resourceId
-
- Required: Yes
- Type: string
Specifies a delete integration response request's resource identifier.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- statusCode
-
- Required: Yes
- Type: string
Specifies a delete integration response request's status code.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteMethod
$result = $client->deleteMethod
([/* ... */]); $promise = $client->deleteMethodAsync
([/* ... */]);
Deletes an existing Method resource.
Parameter Syntax
$result = $client->deleteMethod([ 'httpMethod' => '<string>', // REQUIRED 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
The HTTP verb of the Method resource.
- resourceId
-
- Required: Yes
- Type: string
The Resource identifier for the Method resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[]
Result Details
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
DeleteMethodResponse
$result = $client->deleteMethodResponse
([/* ... */]); $promise = $client->deleteMethodResponseAsync
([/* ... */]);
Deletes an existing MethodResponse resource.
Parameter Syntax
$result = $client->deleteMethodResponse([ 'httpMethod' => '<string>', // REQUIRED 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED 'statusCode' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
The HTTP verb of the Method resource.
- resourceId
-
- Required: Yes
- Type: string
The Resource identifier for the MethodResponse resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- statusCode
-
- Required: Yes
- Type: string
The status code identifier for the MethodResponse resource.
Result Syntax
[]
Result Details
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
DeleteModel
$result = $client->deleteModel
([/* ... */]); $promise = $client->deleteModelAsync
([/* ... */]);
Deletes a model.
Parameter Syntax
$result = $client->deleteModel([ 'modelName' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- modelName
-
- Required: Yes
- Type: string
The name of the model to delete.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteRequestValidator
$result = $client->deleteRequestValidator
([/* ... */]); $promise = $client->deleteRequestValidatorAsync
([/* ... */]);
Deletes a RequestValidator of a given RestApi.
Parameter Syntax
$result = $client->deleteRequestValidator([ 'requestValidatorId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- requestValidatorId
-
- Required: Yes
- Type: string
The identifier of the RequestValidator to be deleted.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteResource
$result = $client->deleteResource
([/* ... */]); $promise = $client->deleteResourceAsync
([/* ... */]);
Deletes a Resource resource.
Parameter Syntax
$result = $client->deleteResource([ 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- resourceId
-
- Required: Yes
- Type: string
The identifier of the Resource resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[]
Result Details
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteRestApi
$result = $client->deleteRestApi
([/* ... */]); $promise = $client->deleteRestApiAsync
([/* ... */]);
Deletes the specified API.
Parameter Syntax
$result = $client->deleteRestApi([ 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteStage
$result = $client->deleteStage
([/* ... */]); $promise = $client->deleteStageAsync
([/* ... */]);
Deletes a Stage resource.
Parameter Syntax
$result = $client->deleteStage([ 'restApiId' => '<string>', // REQUIRED 'stageName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- stageName
-
- Required: Yes
- Type: string
The name of the Stage resource to delete.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteUsagePlan
$result = $client->deleteUsagePlan
([/* ... */]); $promise = $client->deleteUsagePlanAsync
([/* ... */]);
Deletes a usage plan of a given plan Id.
Parameter Syntax
$result = $client->deleteUsagePlan([ 'usagePlanId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- usagePlanId
-
- Required: Yes
- Type: string
The Id of the to-be-deleted usage plan.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteUsagePlanKey
$result = $client->deleteUsagePlanKey
([/* ... */]); $promise = $client->deleteUsagePlanKeyAsync
([/* ... */]);
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
Parameter Syntax
$result = $client->deleteUsagePlanKey([ 'keyId' => '<string>', // REQUIRED 'usagePlanId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- keyId
-
- Required: Yes
- Type: string
The Id of the UsagePlanKey resource to be deleted.
- usagePlanId
-
- Required: Yes
- Type: string
The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
DeleteVpcLink
$result = $client->deleteVpcLink
([/* ... */]); $promise = $client->deleteVpcLinkAsync
([/* ... */]);
Deletes an existing VpcLink of a specified identifier.
Parameter Syntax
$result = $client->deleteVpcLink([ 'vpcLinkId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- vpcLinkId
-
- Required: Yes
- Type: string
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
FlushStageAuthorizersCache
$result = $client->flushStageAuthorizersCache
([/* ... */]); $promise = $client->flushStageAuthorizersCacheAsync
([/* ... */]);
Flushes all authorizer cache entries on a stage.
Parameter Syntax
$result = $client->flushStageAuthorizersCache([ 'restApiId' => '<string>', // REQUIRED 'stageName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- stageName
-
- Required: Yes
- Type: string
The name of the stage to flush.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
FlushStageCache
$result = $client->flushStageCache
([/* ... */]); $promise = $client->flushStageCacheAsync
([/* ... */]);
Flushes a stage's cache.
Parameter Syntax
$result = $client->flushStageCache([ 'restApiId' => '<string>', // REQUIRED 'stageName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- stageName
-
- Required: Yes
- Type: string
The name of the stage to flush its cache.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GenerateClientCertificate
$result = $client->generateClientCertificate
([/* ... */]); $promise = $client->generateClientCertificateAsync
([/* ... */]);
Generates a ClientCertificate resource.
Parameter Syntax
$result = $client->generateClientCertificate([ 'description' => '<string>', 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- description
-
- Type: string
The description of the ClientCertificate.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters.
Result Syntax
[ 'clientCertificateId' => '<string>', 'createdDate' => <DateTime>, 'description' => '<string>', 'expirationDate' => <DateTime>, 'pemEncodedCertificate' => '<string>', 'tags' => ['<string>', ...], ]
Result Details
Members
- clientCertificateId
-
- Type: string
The identifier of the client certificate.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the client certificate was created.
- description
-
- Type: string
The description of the client certificate.
- expirationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the client certificate will expire.
- pemEncodedCertificate
-
- Type: string
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetAccount
$result = $client->getAccount
([/* ... */]); $promise = $client->getAccountAsync
([/* ... */]);
Gets information about the current Account resource.
Parameter Syntax
$result = $client->getAccount([ ]);
Parameter Details
Members
Result Syntax
[ 'apiKeyVersion' => '<string>', 'cloudwatchRoleArn' => '<string>', 'features' => ['<string>', ...], 'throttleSettings' => [ 'burstLimit' => <integer>, 'rateLimit' => <float>, ], ]
Result Details
Members
- apiKeyVersion
-
- Type: string
The version of the API keys used for the account.
- cloudwatchRoleArn
-
- Type: string
The ARN of an Amazon CloudWatch role for the current Account.
- features
-
- Type: Array of strings
A list of features supported for the account. When usage plans are enabled, the features list will include an entry of
"UsagePlans"
. - throttleSettings
-
- Type: ThrottleSettings structure
Specifies the API request limits configured for the current Account.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetApiKey
$result = $client->getApiKey
([/* ... */]); $promise = $client->getApiKeyAsync
([/* ... */]);
Gets information about the current ApiKey resource.
Parameter Syntax
$result = $client->getApiKey([ 'apiKey' => '<string>', // REQUIRED 'includeValue' => true || false, ]);
Parameter Details
Members
- apiKey
-
- Required: Yes
- Type: string
The identifier of the ApiKey resource.
- includeValue
-
- Type: boolean
A boolean flag to specify whether (
true
) or not (false
) the result contains the key value.
Result Syntax
[ 'createdDate' => <DateTime>, 'customerId' => '<string>', 'description' => '<string>', 'enabled' => true || false, 'id' => '<string>', 'lastUpdatedDate' => <DateTime>, 'name' => '<string>', 'stageKeys' => ['<string>', ...], 'tags' => ['<string>', ...], 'value' => '<string>', ]
Result Details
Members
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the API Key was created.
- customerId
-
- Type: string
An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
- description
-
- Type: string
The description of the API Key.
- enabled
-
- Type: boolean
Specifies whether the API Key can be used by callers.
- id
-
- Type: string
The identifier of the API Key.
- lastUpdatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the API Key was last updated.
- name
-
- Type: string
The name of the API Key.
- stageKeys
-
- Type: Array of strings
A list of Stage resources that are associated with the ApiKey resource.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- value
-
- Type: string
The value of the API Key.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetApiKeys
$result = $client->getApiKeys
([/* ... */]); $promise = $client->getApiKeysAsync
([/* ... */]);
Gets information about the current ApiKeys resource.
Parameter Syntax
$result = $client->getApiKeys([ 'customerId' => '<string>', 'includeValues' => true || false, 'limit' => <integer>, 'nameQuery' => '<string>', 'position' => '<string>', ]);
Parameter Details
Members
- customerId
-
- Type: string
The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.
- includeValues
-
- Type: boolean
A boolean flag to specify whether (
true
) or not (false
) the result contains key values. - limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- nameQuery
-
- Type: string
The name of queried API keys.
- position
-
- Type: string
The current pagination position in the paged result set.
Result Syntax
[ 'items' => [ [ 'createdDate' => <DateTime>, 'customerId' => '<string>', 'description' => '<string>', 'enabled' => true || false, 'id' => '<string>', 'lastUpdatedDate' => <DateTime>, 'name' => '<string>', 'stageKeys' => ['<string>', ...], 'tags' => ['<string>', ...], 'value' => '<string>', ], // ... ], 'position' => '<string>', 'warnings' => ['<string>', ...], ]
Result Details
Members
- items
-
- Type: Array of ApiKey structures
The current page of elements from this collection.
- position
-
- Type: string
- warnings
-
- Type: Array of strings
A list of warning messages logged during the import of API keys when the
failOnWarnings
option is set to true.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetAuthorizer
$result = $client->getAuthorizer
([/* ... */]); $promise = $client->getAuthorizerAsync
([/* ... */]);
Describe an existing Authorizer resource.
Parameter Syntax
$result = $client->getAuthorizer([ 'authorizerId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- authorizerId
-
- Required: Yes
- Type: string
The identifier of the Authorizer resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'authType' => '<string>', 'authorizerCredentials' => '<string>', 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'id' => '<string>', 'identitySource' => '<string>', 'identityValidationExpression' => '<string>', 'name' => '<string>', 'providerARNs' => ['<string>', ...], 'type' => 'TOKEN|REQUEST|COGNITO_USER_POOLS', ]
Result Details
Members
- authType
-
- Type: string
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
- authorizerCredentials
-
- Type: string
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.
- authorizerResultTtlInSeconds
-
- Type: int
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.
- authorizerUri
-
- Type: string
Specifies the authorizer's Uniform Resource Identifier (URI). For
TOKEN
orREQUEST
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 formarn: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
. - id
-
- Type: string
The identifier for the authorizer resource.
- identitySource
-
- Type: string
The identity source for which authorization is requested. For a
TOKEN
orCOGNITO_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 isAuth
, the header mapping expression ismethod.request.header.Auth
. For theREQUEST
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 anAuth
header, aName
query string parameter are defined as identity sources, this value ismethod.request.header.Auth
,method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional. - identityValidationExpression
-
- Type: string
A validation expression for the incoming identity token. For
TOKEN
authorizers, this value is a regular expression. ForCOGNITO_USER_POOLS
authorizers, API Gateway will match theaud
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 theREQUEST
authorizer. - name
-
- Type: string
The name of the authorizer.
- providerARNs
-
- Type: Array of strings
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 aTOKEN
orREQUEST
authorizer, this is not defined. - type
-
- Type: string
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, andCOGNITO_USER_POOLS
for using an Amazon Cognito user pool.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetAuthorizers
$result = $client->getAuthorizers
([/* ... */]); $promise = $client->getAuthorizersAsync
([/* ... */]);
Describe an existing Authorizers resource.
Parameter Syntax
$result = $client->getAuthorizers([ 'limit' => <integer>, 'position' => '<string>', 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'items' => [ [ 'authType' => '<string>', 'authorizerCredentials' => '<string>', 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'id' => '<string>', 'identitySource' => '<string>', 'identityValidationExpression' => '<string>', 'name' => '<string>', 'providerARNs' => ['<string>', ...], 'type' => 'TOKEN|REQUEST|COGNITO_USER_POOLS', ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of Authorizer structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetBasePathMapping
$result = $client->getBasePathMapping
([/* ... */]); $promise = $client->getBasePathMappingAsync
([/* ... */]);
Describe a BasePathMapping resource.
Parameter Syntax
$result = $client->getBasePathMapping([ 'basePath' => '<string>', // REQUIRED 'domainName' => '<string>', // REQUIRED 'domainNameId' => '<string>', ]);
Parameter Details
Members
- basePath
-
- Required: Yes
- Type: string
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.
- domainName
-
- Required: Yes
- Type: string
The domain name of the BasePathMapping resource to be described.
- domainNameId
-
- Type: string
The identifier for the domain name resource. Supported only for private custom domain names.
Result Syntax
[ 'basePath' => '<string>', 'restApiId' => '<string>', 'stage' => '<string>', ]
Result Details
Members
- basePath
-
- Type: string
The base path name that callers of the API must provide as part of the URL after the domain name.
- restApiId
-
- Type: string
The string identifier of the associated RestApi.
- stage
-
- Type: string
The name of the associated stage.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetBasePathMappings
$result = $client->getBasePathMappings
([/* ... */]); $promise = $client->getBasePathMappingsAsync
([/* ... */]);
Represents a collection of BasePathMapping resources.
Parameter Syntax
$result = $client->getBasePathMappings([ 'domainName' => '<string>', // REQUIRED 'domainNameId' => '<string>', 'limit' => <integer>, 'position' => '<string>', ]);
Parameter Details
Members
- domainName
-
- Required: Yes
- Type: string
The domain name of a BasePathMapping resource.
- domainNameId
-
- Type: string
The identifier for the domain name resource. Supported only for private custom domain names.
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
Result Syntax
[ 'items' => [ [ 'basePath' => '<string>', 'restApiId' => '<string>', 'stage' => '<string>', ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of BasePathMapping structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetClientCertificate
$result = $client->getClientCertificate
([/* ... */]); $promise = $client->getClientCertificateAsync
([/* ... */]);
Gets information about the current ClientCertificate resource.
Parameter Syntax
$result = $client->getClientCertificate([ 'clientCertificateId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientCertificateId
-
- Required: Yes
- Type: string
The identifier of the ClientCertificate resource to be described.
Result Syntax
[ 'clientCertificateId' => '<string>', 'createdDate' => <DateTime>, 'description' => '<string>', 'expirationDate' => <DateTime>, 'pemEncodedCertificate' => '<string>', 'tags' => ['<string>', ...], ]
Result Details
Members
- clientCertificateId
-
- Type: string
The identifier of the client certificate.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the client certificate was created.
- description
-
- Type: string
The description of the client certificate.
- expirationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the client certificate will expire.
- pemEncodedCertificate
-
- Type: string
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetClientCertificates
$result = $client->getClientCertificates
([/* ... */]); $promise = $client->getClientCertificatesAsync
([/* ... */]);
Gets a collection of ClientCertificate resources.
Parameter Syntax
$result = $client->getClientCertificates([ 'limit' => <integer>, 'position' => '<string>', ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
Result Syntax
[ 'items' => [ [ 'clientCertificateId' => '<string>', 'createdDate' => <DateTime>, 'description' => '<string>', 'expirationDate' => <DateTime>, 'pemEncodedCertificate' => '<string>', 'tags' => ['<string>', ...], ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of ClientCertificate structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetDeployment
$result = $client->getDeployment
([/* ... */]); $promise = $client->getDeploymentAsync
([/* ... */]);
Gets information about a Deployment resource.
Parameter Syntax
$result = $client->getDeployment([ 'deploymentId' => '<string>', // REQUIRED 'embed' => ['<string>', ...], 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- deploymentId
-
- Required: Yes
- Type: string
The identifier of the Deployment resource to get information about.
- embed
-
- Type: Array of strings
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 inGET /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
. - restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'apiSummary' => [ '<String>' => [ '<String>' => [ 'apiKeyRequired' => true || false, 'authorizationType' => '<string>', ], // ... ], // ... ], 'createdDate' => <DateTime>, 'description' => '<string>', 'id' => '<string>', ]
Result Details
Members
- apiSummary
-
- Type: Associative array of custom strings keys (String) to MethodSnapshot structuress
A summary of the RestApi at the date and time that the deployment resource was created.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the deployment resource was created.
- description
-
- Type: string
The description for the deployment resource.
- id
-
- Type: string
The identifier for the deployment resource.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
- ServiceUnavailableException:
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
GetDeployments
$result = $client->getDeployments
([/* ... */]); $promise = $client->getDeploymentsAsync
([/* ... */]);
Gets information about a Deployments collection.
Parameter Syntax
$result = $client->getDeployments([ 'limit' => <integer>, 'position' => '<string>', 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'items' => [ [ 'apiSummary' => [ '<String>' => [ '<String>' => [ 'apiKeyRequired' => true || false, 'authorizationType' => '<string>', ], // ... ], // ... ], 'createdDate' => <DateTime>, 'description' => '<string>', 'id' => '<string>', ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of Deployment structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
- ServiceUnavailableException:
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
GetDocumentationPart
$result = $client->getDocumentationPart
([/* ... */]); $promise = $client->getDocumentationPartAsync
([/* ... */]);
Gets a documentation part.
Parameter Syntax
$result = $client->getDocumentationPart([ 'documentationPartId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- documentationPartId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'id' => '<string>', 'location' => [ 'method' => '<string>', 'name' => '<string>', 'path' => '<string>', 'statusCode' => '<string>', 'type' => 'API|AUTHORIZER|MODEL|RESOURCE|METHOD|PATH_PARAMETER|QUERY_PARAMETER|REQUEST_HEADER|REQUEST_BODY|RESPONSE|RESPONSE_HEADER|RESPONSE_BODY', ], 'properties' => '<string>', ]
Result Details
Members
- id
-
- Type: string
The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart
is created. - location
-
- Type: DocumentationPartLocation structure
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.
- properties
-
- Type: string
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 ofx-amazon-apigateway-documentation
.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetDocumentationParts
$result = $client->getDocumentationParts
([/* ... */]); $promise = $client->getDocumentationPartsAsync
([/* ... */]);
Gets documentation parts.
Parameter Syntax
$result = $client->getDocumentationParts([ 'limit' => <integer>, 'locationStatus' => 'DOCUMENTED|UNDOCUMENTED', 'nameQuery' => '<string>', 'path' => '<string>', 'position' => '<string>', 'restApiId' => '<string>', // REQUIRED 'type' => 'API|AUTHORIZER|MODEL|RESOURCE|METHOD|PATH_PARAMETER|QUERY_PARAMETER|REQUEST_HEADER|REQUEST_BODY|RESPONSE|RESPONSE_HEADER|RESPONSE_BODY', ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- locationStatus
-
- Type: string
The status of the API documentation parts to retrieve. Valid values are
DOCUMENTED
for retrieving DocumentationPart resources with content andUNDOCUMENTED
for DocumentationPart resources without content. - nameQuery
-
- Type: string
The name of API entities of the to-be-retrieved documentation parts.
- path
-
- Type: string
The path of API entities of the to-be-retrieved documentation parts.
- position
-
- Type: string
The current pagination position in the paged result set.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- type
-
- Type: string
The type of API entities of the to-be-retrieved documentation parts.
Result Syntax
[ 'items' => [ [ 'id' => '<string>', 'location' => [ 'method' => '<string>', 'name' => '<string>', 'path' => '<string>', 'statusCode' => '<string>', 'type' => 'API|AUTHORIZER|MODEL|RESOURCE|METHOD|PATH_PARAMETER|QUERY_PARAMETER|REQUEST_HEADER|REQUEST_BODY|RESPONSE|RESPONSE_HEADER|RESPONSE_BODY', ], 'properties' => '<string>', ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of DocumentationPart structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetDocumentationVersion
$result = $client->getDocumentationVersion
([/* ... */]); $promise = $client->getDocumentationVersionAsync
([/* ... */]);
Gets a documentation version.
Parameter Syntax
$result = $client->getDocumentationVersion([ 'documentationVersion' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- documentationVersion
-
- Required: Yes
- Type: string
The version identifier of the to-be-retrieved documentation snapshot.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'createdDate' => <DateTime>, 'description' => '<string>', 'version' => '<string>', ]
Result Details
Members
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date when the API documentation snapshot is created.
- description
-
- Type: string
The description of the API documentation snapshot.
- version
-
- Type: string
The version identifier of the API documentation snapshot.
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetDocumentationVersions
$result = $client->getDocumentationVersions
([/* ... */]); $promise = $client->getDocumentationVersionsAsync
([/* ... */]);
Gets documentation versions.
Parameter Syntax
$result = $client->getDocumentationVersions([ 'limit' => <integer>, 'position' => '<string>', 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'items' => [ [ 'createdDate' => <DateTime>, 'description' => '<string>', 'version' => '<string>', ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of DocumentationVersion structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetDomainName
$result = $client->getDomainName
([/* ... */]); $promise = $client->getDomainNameAsync
([/* ... */]);
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
Parameter Syntax
$result = $client->getDomainName([ 'domainName' => '<string>', // REQUIRED 'domainNameId' => '<string>', ]);
Parameter Details
Members
- domainName
-
- Required: Yes
- Type: string
The name of the DomainName resource.
- domainNameId
-
- Type: string
The identifier for the domain name resource. Supported only for private custom domain names.
Result Syntax
[ 'certificateArn' => '<string>', 'certificateName' => '<string>', 'certificateUploadDate' => <DateTime>, 'distributionDomainName' => '<string>', 'distributionHostedZoneId' => '<string>', 'domainName' => '<string>', 'domainNameArn' => '<string>', 'domainNameId' => '<string>', 'domainNameStatus' => 'AVAILABLE|UPDATING|PENDING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION', 'domainNameStatusMessage' => '<string>', 'endpointConfiguration' => [ '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>', 'securityPolicy' => 'TLS_1_0|TLS_1_2', 'tags' => ['<string>', ...], ]
Result Details
Members
- certificateArn
-
- Type: string
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.
- certificateName
-
- Type: string
The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
- certificateUploadDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.
- distributionDomainName
-
- Type: string
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.
- distributionHostedZoneId
-
- Type: string
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. - domainName
-
- Type: string
The custom domain name as an API host name, for example,
my-api.example.com
. - domainNameArn
-
- Type: string
The ARN of the domain name. Supported only for private custom domain names.
- domainNameId
-
- Type: string
The identifier for the domain name resource. Supported only for private custom domain names.
- domainNameStatus
-
- Type: string
The status of the DomainName migration. The valid values are
AVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, the domain can be updated. - domainNameStatusMessage
-
- Type: string
An optional text message containing detailed information about status of the DomainName migration.
- endpointConfiguration
-
- Type: EndpointConfiguration structure
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
- managementPolicy
-
- Type: string
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.
- mutualTlsAuthentication
-
- Type: MutualTlsAuthentication structure
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.
- ownershipVerificationCertificateArn
-
- Type: string
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.
- policy
-
- Type: string
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. - regionalCertificateArn
-
- Type: string
The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
- regionalCertificateName
-
- Type: string
The name of the certificate that will be used for validating the regional domain name.
- regionalDomainName
-
- Type: string
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.
- regionalHostedZoneId
-
- Type: string
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.
- securityPolicy
-
- Type: string
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
. - tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetDomainNameAccessAssociations
$result = $client->getDomainNameAccessAssociations
([/* ... */]); $promise = $client->getDomainNameAccessAssociationsAsync
([/* ... */]);
Represents a collection on DomainNameAccessAssociations resources.
Parameter Syntax
$result = $client->getDomainNameAccessAssociations([ 'limit' => <integer>, 'position' => '<string>', 'resourceOwner' => 'SELF|OTHER_ACCOUNTS', ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
- resourceOwner
-
- Type: string
The owner of the domain name access association. Use
SELF
to only list the domain name access associations owned by your own account. UseOTHER_ACCOUNTS
to list the domain name access associations with your private custom domain names that are owned by other AWS accounts.
Result Syntax
[ 'items' => [ [ 'accessAssociationSource' => '<string>', 'accessAssociationSourceType' => 'VPCE', 'domainNameAccessAssociationArn' => '<string>', 'domainNameArn' => '<string>', 'tags' => ['<string>', ...], ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of DomainNameAccessAssociation structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetDomainNames
$result = $client->getDomainNames
([/* ... */]); $promise = $client->getDomainNamesAsync
([/* ... */]);
Represents a collection of DomainName resources.
Parameter Syntax
$result = $client->getDomainNames([ 'limit' => <integer>, 'position' => '<string>', 'resourceOwner' => 'SELF|OTHER_ACCOUNTS', ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
- resourceOwner
-
- Type: string
The owner of the domain name access association.
Result Syntax
[ 'items' => [ [ 'certificateArn' => '<string>', 'certificateName' => '<string>', 'certificateUploadDate' => <DateTime>, 'distributionDomainName' => '<string>', 'distributionHostedZoneId' => '<string>', 'domainName' => '<string>', 'domainNameArn' => '<string>', 'domainNameId' => '<string>', 'domainNameStatus' => 'AVAILABLE|UPDATING|PENDING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION', 'domainNameStatusMessage' => '<string>', 'endpointConfiguration' => [ '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>', 'securityPolicy' => 'TLS_1_0|TLS_1_2', 'tags' => ['<string>', ...], ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of DomainName structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetExport
$result = $client->getExport
([/* ... */]); $promise = $client->getExportAsync
([/* ... */]);
Exports a deployed version of a RestApi in a specified format.
Parameter Syntax
$result = $client->getExport([ 'accepts' => '<string>', 'exportType' => '<string>', // REQUIRED 'parameters' => ['<string>', ...], 'restApiId' => '<string>', // REQUIRED 'stageName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- accepts
-
- Type: string
The content-type of the export, for example
application/json
. Currentlyapplication/json
andapplication/yaml
are supported forexportType
ofoas30
andswagger
. This should be specified in theAccept
header for direct API requests. - exportType
-
- Required: Yes
- Type: string
The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
- parameters
-
- Type: Associative array of custom strings keys (String) to strings
A key-value map of query string parameters that specify properties of the export, depending on the requested
exportType
. ForexportType
oas30
andswagger
, any combination of the following parameters are supported:extensions='integrations'
orextensions='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 - restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- stageName
-
- Required: Yes
- Type: string
The name of the Stage that will be exported.
Result Syntax
[ 'body' => <string || resource || Psr\Http\Message\StreamInterface>, 'contentDisposition' => '<string>', 'contentType' => '<string>', ]
Result Details
Members
- body
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The binary blob response to GetExport, which contains the export.
- contentDisposition
-
- Type: string
The content-disposition header value in the HTTP response.
- contentType
-
- Type: string
The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetGatewayResponse
$result = $client->getGatewayResponse
([/* ... */]); $promise = $client->getGatewayResponseAsync
([/* ... */]);
Gets a GatewayResponse of a specified response type on the given RestApi.
Parameter Syntax
$result = $client->getGatewayResponse([ 'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED|WAF_FILTERED', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- responseType
-
- Required: Yes
- Type: string
The response type of the associated GatewayResponse.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'defaultResponse' => true || false, 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED|WAF_FILTERED', 'statusCode' => '<string>', ]
Result Details
Members
- defaultResponse
-
- Type: boolean
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. - responseParameters
-
- Type: Associative array of custom strings keys (String) to strings
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
- responseTemplates
-
- Type: Associative array of custom strings keys (String) to strings
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
- responseType
-
- Type: string
The response type of the associated GatewayResponse.
- statusCode
-
- Type: string
The HTTP status code for this GatewayResponse.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetGatewayResponses
$result = $client->getGatewayResponses
([/* ... */]); $promise = $client->getGatewayResponsesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getGatewayResponses([ 'limit' => <integer>, 'position' => '<string>', 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- limit
-
- Type: int
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
-
- Type: string
The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'items' => [ [ 'defaultResponse' => true || false, 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED|WAF_FILTERED', 'statusCode' => '<string>', ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of GatewayResponse structures
Returns the entire collection, because of no pagination support.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetIntegration
$result = $client->getIntegration
([/* ... */]); $promise = $client->getIntegrationAsync
([/* ... */]);
Get the integration settings.
Parameter Syntax
$result = $client->getIntegration([ 'httpMethod' => '<string>', // REQUIRED 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
Specifies a get integration request's HTTP method.
- resourceId
-
- Required: Yes
- Type: string
Specifies a get integration request's resource identifier
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'cacheKeyParameters' => ['<string>', ...], 'cacheNamespace' => '<string>', 'connectionId' => '<string>', 'connectionType' => 'INTERNET|VPC_LINK', 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'credentials' => '<string>', 'httpMethod' => '<string>', 'integrationResponses' => [ '<String>' => [ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ], // ... ], 'passthroughBehavior' => '<string>', 'requestParameters' => ['<string>', ...], 'requestTemplates' => ['<string>', ...], 'timeoutInMillis' => <integer>, 'tlsConfig' => [ 'insecureSkipVerification' => true || false, ], 'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY', 'uri' => '<string>', ]
Result Details
Members
- cacheKeyParameters
-
- Type: Array of strings
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
. - cacheNamespace
-
- Type: string
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources. - connectionId
-
- Type: string
The ID of the VpcLink used for the integration when
connectionType=VPC_LINK
and undefined, otherwise. - connectionType
-
- Type: string
The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
. - contentHandling
-
- Type: string
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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. - credentials
-
- Type: string
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 Amazon Web Services services, specify null. - httpMethod
-
- Type: string
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 toPOST
. For all other types, you must specify this property. - integrationResponses
-
- Type: Associative array of custom strings keys (String) to IntegrationResponse structures
Specifies the integration's responses.
- passthroughBehavior
-
- Type: string
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. - requestParameters
-
- Type: Associative array of custom strings keys (String) to strings
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}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name. - requestTemplates
-
- Type: Associative array of custom strings keys (String) to strings
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.
- timeoutInMillis
-
- Type: int
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
- tlsConfig
-
- Type: TlsConfig structure
Specifies the TLS configuration for an integration.
- type
-
- Type: string
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 aconnectionType
ofVPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC. - uri
-
- Type: string
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For
HTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. IfconnectionType
isVPC_LINK
specify the Network Load Balancer DNS name. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}
. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetIntegrationResponse
$result = $client->getIntegrationResponse
([/* ... */]); $promise = $client->getIntegrationResponseAsync
([/* ... */]);
Represents a get integration response.
Parameter Syntax
$result = $client->getIntegrationResponse([ 'httpMethod' => '<string>', // REQUIRED 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED 'statusCode' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
Specifies a get integration response request's HTTP method.
- resourceId
-
- Required: Yes
- Type: string
Specifies a get integration response request's resource identifier.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- statusCode
-
- Required: Yes
- Type: string
Specifies a get integration response request's status code.
Result Syntax
[ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ]
Result Details
Members
- contentHandling
-
- Type: string
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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.
- responseParameters
-
- Type: Associative array of custom strings keys (String) to strings
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}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
is a valid and unique response header name andJSON-expression
is a valid JSON expression without the$
prefix. - responseTemplates
-
- Type: Associative array of custom strings keys (String) to strings
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.
- selectionPattern
-
- Type: string
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 Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched. - statusCode
-
- Type: string
Specifies the status code that is used to map the integration response to an existing MethodResponse.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetMethod
$result = $client->getMethod
([/* ... */]); $promise = $client->getMethodAsync
([/* ... */]);
Describe an existing Method resource.
Parameter Syntax
$result = $client->getMethod([ 'httpMethod' => '<string>', // REQUIRED 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
Specifies the method request's HTTP method type.
- resourceId
-
- Required: Yes
- Type: string
The Resource identifier for the Method resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'apiKeyRequired' => true || false, 'authorizationScopes' => ['<string>', ...], 'authorizationType' => '<string>', 'authorizerId' => '<string>', 'httpMethod' => '<string>', 'methodIntegration' => [ 'cacheKeyParameters' => ['<string>', ...], 'cacheNamespace' => '<string>', 'connectionId' => '<string>', 'connectionType' => 'INTERNET|VPC_LINK', 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'credentials' => '<string>', 'httpMethod' => '<string>', 'integrationResponses' => [ '<String>' => [ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ], // ... ], 'passthroughBehavior' => '<string>', 'requestParameters' => ['<string>', ...], 'requestTemplates' => ['<string>', ...], 'timeoutInMillis' => <integer>, 'tlsConfig' => [ 'insecureSkipVerification' => true || false, ], 'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY', 'uri' => '<string>', ], 'methodResponses' => [ '<String>' => [ 'responseModels' => ['<string>', ...], 'responseParameters' => [true || false, ...], 'statusCode' => '<string>', ], // ... ], 'operationName' => '<string>', 'requestModels' => ['<string>', ...], 'requestParameters' => [true || false, ...], 'requestValidatorId' => '<string>', ]
Result Details
Members
- apiKeyRequired
-
- Type: boolean
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
- authorizationScopes
-
- Type: Array of strings
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. - authorizationType
-
- Type: string
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, orCOGNITO_USER_POOLS
for using a Cognito user pool. - authorizerId
-
- Type: string
The identifier of an Authorizer to use on this method. The
authorizationType
must beCUSTOM
. - httpMethod
-
- Type: string
The method's HTTP verb.
- methodIntegration
-
- Type: Integration structure
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.
- methodResponses
-
- Type: Associative array of custom strings keys (String) to MethodResponse structures
Gets a method response associated with a given HTTP status code.
- operationName
-
- Type: string
A human-friendly operation identifier for the method. For example, you can assign the
operationName
ofListPets
for theGET /pets
method in thePetStore
example. - requestModels
-
- Type: Associative array of custom strings keys (String) to strings
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).
- requestParameters
-
- Type: Associative array of custom strings keys (String) to booleans
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}
, wherelocation
isquerystring
,path
, orheader
andname
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. - requestValidatorId
-
- Type: string
The identifier of a RequestValidator for request validation.
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetMethodResponse
$result = $client->getMethodResponse
([/* ... */]); $promise = $client->getMethodResponseAsync
([/* ... */]);
Describes a MethodResponse resource.
Parameter Syntax
$result = $client->getMethodResponse([ 'httpMethod' => '<string>', // REQUIRED 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED 'statusCode' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
The HTTP verb of the Method resource.
- resourceId
-
- Required: Yes
- Type: string
The Resource identifier for the MethodResponse resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- statusCode
-
- Required: Yes
- Type: string
The status code for the MethodResponse resource.
Result Syntax
[ 'responseModels' => ['<string>', ...], 'responseParameters' => [true || false, ...], 'statusCode' => '<string>', ]
Result Details
Members
- responseModels
-
- Type: Associative array of custom strings keys (String) to strings
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.
- responseParameters
-
- Type: Associative array of custom strings keys (String) to booleans
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}
, wherename
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 inintegration.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 ofintegration.response.body.{JSON-expression}
, whereJSON-expression
is a valid JSON expression without the$
prefix.) - statusCode
-
- Type: string
The method response's status code.
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetModel
$result = $client->getModel
([/* ... */]); $promise = $client->getModelAsync
([/* ... */]);
Describes an existing model defined for a RestApi resource.
Parameter Syntax
$result = $client->getModel([ 'flatten' => true || false, 'modelName' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- flatten
-
- Type: boolean
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 isfalse
. - modelName
-
- Required: Yes
- Type: string
The name of the model as an identifier.
- restApiId
-
- Required: Yes
- Type: string
The RestApi identifier under which the Model exists.
Result Syntax
[ 'contentType' => '<string>', 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'schema' => '<string>', ]
Result Details
Members
- contentType
-
- Type: string
The content-type for the model.
- description
-
- Type: string
The description of the model.
- id
-
- Type: string
The identifier for the model resource.
- name
-
- Type: string
The name of the model. Must be an alphanumeric string.
- schema
-
- Type: string
The schema for the model. For
application/json
models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetModelTemplate
$result = $client->getModelTemplate
([/* ... */]); $promise = $client->getModelTemplateAsync
([/* ... */]);
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
Parameter Syntax
$result = $client->getModelTemplate([ 'modelName' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- modelName
-
- Required: Yes
- Type: string
The name of the model for which to generate a template.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'value' => '<string>', ]
Result Details
Members
- value
-
- Type: string
The Apache Velocity Template Language (VTL) template content used for the template resource.
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetModels
$result = $client->getModels
([/* ... */]); $promise = $client->getModelsAsync
([/* ... */]);
Describes existing Models defined for a RestApi resource.
Parameter Syntax
$result = $client->getModels([ 'limit' => <integer>, 'position' => '<string>', 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'items' => [ [ 'contentType' => '<string>', 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'schema' => '<string>', ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of Model structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetRequestValidator
$result = $client->getRequestValidator
([/* ... */]); $promise = $client->getRequestValidatorAsync
([/* ... */]);
Gets a RequestValidator of a given RestApi.
Parameter Syntax
$result = $client->getRequestValidator([ 'requestValidatorId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- requestValidatorId
-
- Required: Yes
- Type: string
The identifier of the RequestValidator to be retrieved.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'id' => '<string>', 'name' => '<string>', 'validateRequestBody' => true || false, 'validateRequestParameters' => true || false, ]
Result Details
Members
- id
-
- Type: string
The identifier of this RequestValidator.
- name
-
- Type: string
The name of this RequestValidator
- validateRequestBody
-
- Type: boolean
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
- validateRequestParameters
-
- Type: boolean
A Boolean flag to indicate whether to validate request parameters (
true
) or not (false
).
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetRequestValidators
$result = $client->getRequestValidators
([/* ... */]); $promise = $client->getRequestValidatorsAsync
([/* ... */]);
Gets the RequestValidators collection of a given RestApi.
Parameter Syntax
$result = $client->getRequestValidators([ 'limit' => <integer>, 'position' => '<string>', 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'items' => [ [ 'id' => '<string>', 'name' => '<string>', 'validateRequestBody' => true || false, 'validateRequestParameters' => true || false, ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of RequestValidator structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetResource
$result = $client->getResource
([/* ... */]); $promise = $client->getResourceAsync
([/* ... */]);
Lists information about a resource.
Parameter Syntax
$result = $client->getResource([ 'embed' => ['<string>', ...], 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- embed
-
- Type: Array of strings
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
. - resourceId
-
- Required: Yes
- Type: string
The identifier for the Resource resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'id' => '<string>', 'parentId' => '<string>', 'path' => '<string>', 'pathPart' => '<string>', 'resourceMethods' => [ '<String>' => [ 'apiKeyRequired' => true || false, 'authorizationScopes' => ['<string>', ...], 'authorizationType' => '<string>', 'authorizerId' => '<string>', 'httpMethod' => '<string>', 'methodIntegration' => [ 'cacheKeyParameters' => ['<string>', ...], 'cacheNamespace' => '<string>', 'connectionId' => '<string>', 'connectionType' => 'INTERNET|VPC_LINK', 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'credentials' => '<string>', 'httpMethod' => '<string>', 'integrationResponses' => [ '<String>' => [ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ], // ... ], 'passthroughBehavior' => '<string>', 'requestParameters' => ['<string>', ...], 'requestTemplates' => ['<string>', ...], 'timeoutInMillis' => <integer>, 'tlsConfig' => [ 'insecureSkipVerification' => true || false, ], 'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY', 'uri' => '<string>', ], 'methodResponses' => [ '<String>' => [ 'responseModels' => ['<string>', ...], 'responseParameters' => [true || false, ...], 'statusCode' => '<string>', ], // ... ], 'operationName' => '<string>', 'requestModels' => ['<string>', ...], 'requestParameters' => [true || false, ...], 'requestValidatorId' => '<string>', ], // ... ], ]
Result Details
Members
- id
-
- Type: string
The resource's identifier.
- parentId
-
- Type: string
The parent resource's identifier.
- path
-
- Type: string
The full path for this resource.
- pathPart
-
- Type: string
The last path segment for this resource.
- resourceMethods
-
- Type: Associative array of custom strings keys (String) to Method structures
Gets an API resource's method of a given HTTP verb.
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetResources
$result = $client->getResources
([/* ... */]); $promise = $client->getResourcesAsync
([/* ... */]);
Lists information about a collection of Resource resources.
Parameter Syntax
$result = $client->getResources([ 'embed' => ['<string>', ...], 'limit' => <integer>, 'position' => '<string>', 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- embed
-
- Type: Array of strings
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
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'items' => [ [ 'id' => '<string>', 'parentId' => '<string>', 'path' => '<string>', 'pathPart' => '<string>', 'resourceMethods' => [ '<String>' => [ 'apiKeyRequired' => true || false, 'authorizationScopes' => ['<string>', ...], 'authorizationType' => '<string>', 'authorizerId' => '<string>', 'httpMethod' => '<string>', 'methodIntegration' => [ 'cacheKeyParameters' => ['<string>', ...], 'cacheNamespace' => '<string>', 'connectionId' => '<string>', 'connectionType' => 'INTERNET|VPC_LINK', 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'credentials' => '<string>', 'httpMethod' => '<string>', 'integrationResponses' => [ '<String>' => [ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ], // ... ], 'passthroughBehavior' => '<string>', 'requestParameters' => ['<string>', ...], 'requestTemplates' => ['<string>', ...], 'timeoutInMillis' => <integer>, 'tlsConfig' => [ 'insecureSkipVerification' => true || false, ], 'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY', 'uri' => '<string>', ], 'methodResponses' => [ '<String>' => [ 'responseModels' => ['<string>', ...], 'responseParameters' => [true || false, ...], 'statusCode' => '<string>', ], // ... ], 'operationName' => '<string>', 'requestModels' => ['<string>', ...], 'requestParameters' => [true || false, ...], 'requestValidatorId' => '<string>', ], // ... ], ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of Resource structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetRestApi
$result = $client->getRestApi
([/* ... */]); $promise = $client->getRestApiAsync
([/* ... */]);
Lists the RestApi resource in the collection.
Parameter Syntax
$result = $client->getRestApi([ 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'apiKeySource' => 'HEADER|AUTHORIZER', 'binaryMediaTypes' => ['<string>', ...], 'createdDate' => <DateTime>, 'description' => '<string>', 'disableExecuteApiEndpoint' => true || false, 'endpointConfiguration' => [ 'types' => ['<string>', ...], 'vpcEndpointIds' => ['<string>', ...], ], 'id' => '<string>', 'minimumCompressionSize' => <integer>, 'name' => '<string>', 'policy' => '<string>', 'rootResourceId' => '<string>', 'tags' => ['<string>', ...], 'version' => '<string>', 'warnings' => ['<string>', ...], ]
Result Details
Members
- apiKeySource
-
- Type: string
The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer. - binaryMediaTypes
-
- Type: Array of strings
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the API was created.
- description
-
- Type: string
The API's description.
- disableExecuteApiEndpoint
-
- Type: boolean
Specifies whether clients can invoke your API by using the default
execute-api
endpoint. By default, clients can invoke your API with the defaulthttps://{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. - endpointConfiguration
-
- Type: EndpointConfiguration structure
The endpoint configuration of this RestApi showing the endpoint types of the API.
- id
-
- Type: string
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
- minimumCompressionSize
-
- Type: int
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.
- name
-
- Type: string
The API's name.
- policy
-
- Type: string
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
- rootResourceId
-
- Type: string
The API's root resource ID.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- version
-
- Type: string
A version identifier for the API.
- warnings
-
- Type: Array of strings
The warning messages reported when
failonwarnings
is turned on during API import.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetRestApis
$result = $client->getRestApis
([/* ... */]); $promise = $client->getRestApisAsync
([/* ... */]);
Lists the RestApis resources for your collection.
Parameter Syntax
$result = $client->getRestApis([ 'limit' => <integer>, 'position' => '<string>', ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
Result Syntax
[ 'items' => [ [ 'apiKeySource' => 'HEADER|AUTHORIZER', 'binaryMediaTypes' => ['<string>', ...], 'createdDate' => <DateTime>, 'description' => '<string>', 'disableExecuteApiEndpoint' => true || false, 'endpointConfiguration' => [ 'types' => ['<string>', ...], 'vpcEndpointIds' => ['<string>', ...], ], 'id' => '<string>', 'minimumCompressionSize' => <integer>, 'name' => '<string>', 'policy' => '<string>', 'rootResourceId' => '<string>', 'tags' => ['<string>', ...], 'version' => '<string>', 'warnings' => ['<string>', ...], ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of RestApi structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetSdk
$result = $client->getSdk
([/* ... */]); $promise = $client->getSdkAsync
([/* ... */]);
Generates a client SDK for a RestApi and Stage.
Parameter Syntax
$result = $client->getSdk([ 'parameters' => ['<string>', ...], 'restApiId' => '<string>', // REQUIRED 'sdkType' => '<string>', // REQUIRED 'stageName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- parameters
-
- Type: Associative array of custom strings keys (String) to strings
A string-to-string key-value map of query parameters
sdkType
-dependent properties of the SDK. ForsdkType
ofobjectivec
orswift
, a parameter namedclassPrefix
is required. ForsdkType
ofandroid
, parameters namedgroupId
,artifactId
,artifactVersion
, andinvokerPackage
are required. ForsdkType
ofjava
, parameters namedserviceName
andjavaPackageName
are required. - restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- sdkType
-
- Required: Yes
- Type: string
The language for the generated SDK. Currently
java
,javascript
,android
,objectivec
(for iOS),swift
(for iOS), andruby
are supported. - stageName
-
- Required: Yes
- Type: string
The name of the Stage that the SDK will use.
Result Syntax
[ 'body' => <string || resource || Psr\Http\Message\StreamInterface>, 'contentDisposition' => '<string>', 'contentType' => '<string>', ]
Result Details
Members
- body
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The binary blob response to GetSdk, which contains the generated SDK.
- contentDisposition
-
- Type: string
The content-disposition header value in the HTTP response.
- contentType
-
- Type: string
The content-type header value in the HTTP response.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetSdkType
$result = $client->getSdkType
([/* ... */]); $promise = $client->getSdkTypeAsync
([/* ... */]);
Gets an SDK type.
Parameter Syntax
$result = $client->getSdkType([ 'id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- id
-
- Required: Yes
- Type: string
The identifier of the queried SdkType instance.
Result Syntax
[ 'configurationProperties' => [ [ 'defaultValue' => '<string>', 'description' => '<string>', 'friendlyName' => '<string>', 'name' => '<string>', 'required' => true || false, ], // ... ], 'description' => '<string>', 'friendlyName' => '<string>', 'id' => '<string>', ]
Result Details
Members
- configurationProperties
-
- Type: Array of SdkConfigurationProperty structures
A list of configuration properties of an SdkType.
- description
-
- Type: string
The description of an SdkType.
- friendlyName
-
- Type: string
The user-friendly name of an SdkType instance.
- id
-
- Type: string
The identifier of an SdkType instance.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetSdkTypes
$result = $client->getSdkTypes
([/* ... */]); $promise = $client->getSdkTypesAsync
([/* ... */]);
Gets SDK types
Parameter Syntax
$result = $client->getSdkTypes([ 'limit' => <integer>, 'position' => '<string>', ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
Result Syntax
[ 'items' => [ [ 'configurationProperties' => [ [ 'defaultValue' => '<string>', 'description' => '<string>', 'friendlyName' => '<string>', 'name' => '<string>', 'required' => true || false, ], // ... ], 'description' => '<string>', 'friendlyName' => '<string>', 'id' => '<string>', ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of SdkType structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetStage
$result = $client->getStage
([/* ... */]); $promise = $client->getStageAsync
([/* ... */]);
Gets information about a Stage resource.
Parameter Syntax
$result = $client->getStage([ 'restApiId' => '<string>', // REQUIRED 'stageName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- stageName
-
- Required: Yes
- Type: string
The name of the Stage resource to get information about.
Result Syntax
[ 'accessLogSettings' => [ 'destinationArn' => '<string>', 'format' => '<string>', ], 'cacheClusterEnabled' => true || false, 'cacheClusterSize' => '0.5|1.6|6.1|13.5|28.4|58.2|118|237', 'cacheClusterStatus' => 'CREATE_IN_PROGRESS|AVAILABLE|DELETE_IN_PROGRESS|NOT_AVAILABLE|FLUSH_IN_PROGRESS', 'canarySettings' => [ 'deploymentId' => '<string>', 'percentTraffic' => <float>, 'stageVariableOverrides' => ['<string>', ...], 'useStageCache' => true || false, ], 'clientCertificateId' => '<string>', 'createdDate' => <DateTime>, 'deploymentId' => '<string>', 'description' => '<string>', 'documentationVersion' => '<string>', 'lastUpdatedDate' => <DateTime>, 'methodSettings' => [ '<String>' => [ 'cacheDataEncrypted' => true || false, 'cacheTtlInSeconds' => <integer>, 'cachingEnabled' => true || false, 'dataTraceEnabled' => true || false, 'loggingLevel' => '<string>', 'metricsEnabled' => true || false, 'requireAuthorizationForCacheControl' => true || false, 'throttlingBurstLimit' => <integer>, 'throttlingRateLimit' => <float>, 'unauthorizedCacheControlHeaderStrategy' => 'FAIL_WITH_403|SUCCEED_WITH_RESPONSE_HEADER|SUCCEED_WITHOUT_RESPONSE_HEADER', ], // ... ], 'stageName' => '<string>', 'tags' => ['<string>', ...], 'tracingEnabled' => true || false, 'variables' => ['<string>', ...], 'webAclArn' => '<string>', ]
Result Details
Members
- accessLogSettings
-
- Type: AccessLogSettings structure
Settings for logging access in this stage.
- cacheClusterEnabled
-
- Type: boolean
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
totrue
for a method. - cacheClusterSize
-
- Type: string
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
- cacheClusterStatus
-
- Type: string
The status of the cache cluster for the stage, if enabled.
- canarySettings
-
- Type: CanarySettings structure
Settings for the canary deployment in this stage.
- clientCertificateId
-
- Type: string
The identifier of a client certificate for an API stage.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the stage was created.
- deploymentId
-
- Type: string
The identifier of the Deployment that the stage points to.
- description
-
- Type: string
The stage's description.
- documentationVersion
-
- Type: string
The version of the associated API documentation.
- lastUpdatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the stage last updated.
- methodSettings
-
- Type: Associative array of custom strings keys (String) to MethodSetting structures
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. - stageName
-
- Type: string
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.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- tracingEnabled
-
- Type: boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
- variables
-
- Type: Associative array of custom strings keys (String) to strings
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-._~:/?#&=,]+
. - webAclArn
-
- Type: string
The ARN of the WebAcl associated with the Stage.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetStages
$result = $client->getStages
([/* ... */]); $promise = $client->getStagesAsync
([/* ... */]);
Gets information about one or more Stage resources.
Parameter Syntax
$result = $client->getStages([ 'deploymentId' => '<string>', 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- deploymentId
-
- Type: string
The stages' deployment identifiers.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'item' => [ [ 'accessLogSettings' => [ 'destinationArn' => '<string>', 'format' => '<string>', ], 'cacheClusterEnabled' => true || false, 'cacheClusterSize' => '0.5|1.6|6.1|13.5|28.4|58.2|118|237', 'cacheClusterStatus' => 'CREATE_IN_PROGRESS|AVAILABLE|DELETE_IN_PROGRESS|NOT_AVAILABLE|FLUSH_IN_PROGRESS', 'canarySettings' => [ 'deploymentId' => '<string>', 'percentTraffic' => <float>, 'stageVariableOverrides' => ['<string>', ...], 'useStageCache' => true || false, ], 'clientCertificateId' => '<string>', 'createdDate' => <DateTime>, 'deploymentId' => '<string>', 'description' => '<string>', 'documentationVersion' => '<string>', 'lastUpdatedDate' => <DateTime>, 'methodSettings' => [ '<String>' => [ 'cacheDataEncrypted' => true || false, 'cacheTtlInSeconds' => <integer>, 'cachingEnabled' => true || false, 'dataTraceEnabled' => true || false, 'loggingLevel' => '<string>', 'metricsEnabled' => true || false, 'requireAuthorizationForCacheControl' => true || false, 'throttlingBurstLimit' => <integer>, 'throttlingRateLimit' => <float>, 'unauthorizedCacheControlHeaderStrategy' => 'FAIL_WITH_403|SUCCEED_WITH_RESPONSE_HEADER|SUCCEED_WITHOUT_RESPONSE_HEADER', ], // ... ], 'stageName' => '<string>', 'tags' => ['<string>', ...], 'tracingEnabled' => true || false, 'variables' => ['<string>', ...], 'webAclArn' => '<string>', ], // ... ], ]
Result Details
Members
- item
-
- Type: Array of Stage structures
The current page of elements from this collection.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetTags
$result = $client->getTags
([/* ... */]); $promise = $client->getTagsAsync
([/* ... */]);
Gets the Tags collection for a given resource.
Parameter Syntax
$result = $client->getTags([ 'limit' => <integer>, 'position' => '<string>', 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- limit
-
- Type: int
(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
(Not currently supported) The current pagination position in the paged result set.
- resourceArn
-
- Required: Yes
- Type: string
The ARN of a resource that can be tagged.
Result Syntax
[ 'tags' => ['<string>', ...], ]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetUsage
$result = $client->getUsage
([/* ... */]); $promise = $client->getUsageAsync
([/* ... */]);
Gets the usage data of a usage plan in a specified time interval.
Parameter Syntax
$result = $client->getUsage([ 'endDate' => '<string>', // REQUIRED 'keyId' => '<string>', 'limit' => <integer>, 'position' => '<string>', 'startDate' => '<string>', // REQUIRED 'usagePlanId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- endDate
-
- Required: Yes
- Type: string
The ending date (e.g., 2016-12-31) of the usage data.
- keyId
-
- Type: string
The Id of the API key associated with the resultant usage data.
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
- startDate
-
- Required: Yes
- Type: string
The starting date (e.g., 2016-01-01) of the usage data.
- usagePlanId
-
- Required: Yes
- Type: string
The Id of the usage plan associated with the usage data.
Result Syntax
[ 'endDate' => '<string>', 'items' => [ '<String>' => [ [<integer>, ...], // ... ], // ... ], 'position' => '<string>', 'startDate' => '<string>', 'usagePlanId' => '<string>', ]
Result Details
Members
- endDate
-
- Type: string
The ending date of the usage data.
- items
-
- Type: Associative array of custom strings keys (String) to lists
The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example,
{..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}
, where{api_key}
stands for an API key value and the daily log entry is of the format[used quota, remaining quota]
. - position
-
- Type: string
- startDate
-
- Type: string
The starting date of the usage data.
- usagePlanId
-
- Type: string
The plan Id associated with this usage data.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetUsagePlan
$result = $client->getUsagePlan
([/* ... */]); $promise = $client->getUsagePlanAsync
([/* ... */]);
Gets a usage plan of a given plan identifier.
Parameter Syntax
$result = $client->getUsagePlan([ 'usagePlanId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- usagePlanId
-
- Required: Yes
- Type: string
The identifier of the UsagePlan resource to be retrieved.
Result Syntax
[ 'apiStages' => [ [ 'apiId' => '<string>', 'stage' => '<string>', 'throttle' => [ '<String>' => [ 'burstLimit' => <integer>, 'rateLimit' => <float>, ], // ... ], ], // ... ], 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'productCode' => '<string>', 'quota' => [ 'limit' => <integer>, 'offset' => <integer>, 'period' => 'DAY|WEEK|MONTH', ], 'tags' => ['<string>', ...], 'throttle' => [ 'burstLimit' => <integer>, 'rateLimit' => <float>, ], ]
Result Details
Members
- apiStages
-
- Type: Array of ApiStage structures
The associated API stages of a usage plan.
- description
-
- Type: string
The description of a usage plan.
- id
-
- Type: string
The identifier of a UsagePlan resource.
- name
-
- Type: string
The name of a usage plan.
- productCode
-
- Type: string
The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
- quota
-
- Type: QuotaSettings structure
The target maximum number of permitted requests per a given unit time interval.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- throttle
-
- Type: ThrottleSettings structure
A map containing method level throttling information for API stage in a usage plan.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetUsagePlanKey
$result = $client->getUsagePlanKey
([/* ... */]); $promise = $client->getUsagePlanKeyAsync
([/* ... */]);
Gets a usage plan key of a given key identifier.
Parameter Syntax
$result = $client->getUsagePlanKey([ 'keyId' => '<string>', // REQUIRED 'usagePlanId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- keyId
-
- Required: Yes
- Type: string
The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.
- usagePlanId
-
- Required: Yes
- Type: string
The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
Result Syntax
[ 'id' => '<string>', 'name' => '<string>', 'type' => '<string>', 'value' => '<string>', ]
Result Details
Members
- id
-
- Type: string
The Id of a usage plan key.
- name
-
- Type: string
The name of a usage plan key.
- type
-
- Type: string
The type of a usage plan key. Currently, the valid key type is
API_KEY
. - value
-
- Type: string
The value of a usage plan key.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetUsagePlanKeys
$result = $client->getUsagePlanKeys
([/* ... */]); $promise = $client->getUsagePlanKeysAsync
([/* ... */]);
Gets all the usage plan keys representing the API keys added to a specified usage plan.
Parameter Syntax
$result = $client->getUsagePlanKeys([ 'limit' => <integer>, 'nameQuery' => '<string>', 'position' => '<string>', 'usagePlanId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- nameQuery
-
- Type: string
A query parameter specifying the name of the to-be-returned usage plan keys.
- position
-
- Type: string
The current pagination position in the paged result set.
- usagePlanId
-
- Required: Yes
- Type: string
The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
Result Syntax
[ 'items' => [ [ 'id' => '<string>', 'name' => '<string>', 'type' => '<string>', 'value' => '<string>', ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of UsagePlanKey structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetUsagePlans
$result = $client->getUsagePlans
([/* ... */]); $promise = $client->getUsagePlansAsync
([/* ... */]);
Gets all the usage plans of the caller's account.
Parameter Syntax
$result = $client->getUsagePlans([ 'keyId' => '<string>', 'limit' => <integer>, 'position' => '<string>', ]);
Parameter Details
Members
- keyId
-
- Type: string
The identifier of the API key associated with the usage plans.
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
Result Syntax
[ 'items' => [ [ 'apiStages' => [ [ 'apiId' => '<string>', 'stage' => '<string>', 'throttle' => [ '<String>' => [ 'burstLimit' => <integer>, 'rateLimit' => <float>, ], // ... ], ], // ... ], 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'productCode' => '<string>', 'quota' => [ 'limit' => <integer>, 'offset' => <integer>, 'period' => 'DAY|WEEK|MONTH', ], 'tags' => ['<string>', ...], 'throttle' => [ 'burstLimit' => <integer>, 'rateLimit' => <float>, ], ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of UsagePlan structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetVpcLink
$result = $client->getVpcLink
([/* ... */]); $promise = $client->getVpcLinkAsync
([/* ... */]);
Gets a specified VPC link under the caller's account in a region.
Parameter Syntax
$result = $client->getVpcLink([ 'vpcLinkId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- vpcLinkId
-
- Required: Yes
- Type: string
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
Result Syntax
[ 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'status' => 'AVAILABLE|PENDING|DELETING|FAILED', 'statusMessage' => '<string>', 'tags' => ['<string>', ...], 'targetArns' => ['<string>', ...], ]
Result Details
Members
- description
-
- Type: string
The description of the VPC link.
- id
-
- Type: string
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
- name
-
- Type: string
The name used to label and identify the VPC link.
- status
-
- Type: string
The status of the VPC link. The valid values are
AVAILABLE
,PENDING
,DELETING
, orFAILED
. Deploying an API will wait if the status isPENDING
and will fail if the status isDELETING
. - statusMessage
-
- Type: string
A description about the VPC link status.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- targetArns
-
- Type: Array of strings
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 Amazon Web Services account of the API owner.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
GetVpcLinks
$result = $client->getVpcLinks
([/* ... */]); $promise = $client->getVpcLinksAsync
([/* ... */]);
Gets the VpcLinks collection under the caller's account in a selected region.
Parameter Syntax
$result = $client->getVpcLinks([ 'limit' => <integer>, 'position' => '<string>', ]);
Parameter Details
Members
- limit
-
- Type: int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- position
-
- Type: string
The current pagination position in the paged result set.
Result Syntax
[ 'items' => [ [ 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'status' => 'AVAILABLE|PENDING|DELETING|FAILED', 'statusMessage' => '<string>', 'tags' => ['<string>', ...], 'targetArns' => ['<string>', ...], ], // ... ], 'position' => '<string>', ]
Result Details
Members
- items
-
- Type: Array of VpcLink structures
The current page of elements from this collection.
- position
-
- Type: string
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
ImportApiKeys
$result = $client->importApiKeys
([/* ... */]); $promise = $client->importApiKeysAsync
([/* ... */]);
Import API keys from an external source, such as a CSV-formatted file.
Parameter Syntax
$result = $client->importApiKeys([ 'body' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'failOnWarnings' => true || false, 'format' => 'csv', // REQUIRED ]);
Parameter Details
Members
- body
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The payload of the POST request to import API keys. For the payload format, see API Key File Format.
- failOnWarnings
-
- Type: boolean
A query parameter to indicate whether to rollback ApiKey importation (
true
) or not (false
) when error is encountered. - format
-
- Required: Yes
- Type: string
A query parameter to specify the input format to imported API keys. Currently, only the
csv
format is supported.
Result Syntax
[ 'ids' => ['<string>', ...], 'warnings' => ['<string>', ...], ]
Result Details
Members
- ids
-
- Type: Array of strings
A list of all the ApiKey identifiers.
- warnings
-
- Type: Array of strings
A list of warning messages.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
ImportDocumentationParts
$result = $client->importDocumentationParts
([/* ... */]); $promise = $client->importDocumentationPartsAsync
([/* ... */]);
Imports documentation parts
Parameter Syntax
$result = $client->importDocumentationParts([ 'body' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'failOnWarnings' => true || false, 'mode' => 'merge|overwrite', 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- body
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
- failOnWarnings
-
- Type: boolean
A query parameter to specify whether to rollback the documentation importation (
true
) or not (false
) when a warning is encountered. The default value isfalse
. - mode
-
- Type: string
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 ismerge
. - restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'ids' => ['<string>', ...], 'warnings' => ['<string>', ...], ]
Result Details
Members
- ids
-
- Type: Array of strings
A list of the returned documentation part identifiers.
- warnings
-
- Type: Array of strings
A list of warning messages reported during import of documentation parts.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
ImportRestApi
$result = $client->importRestApi
([/* ... */]); $promise = $client->importRestApiAsync
([/* ... */]);
A feature of the API Gateway control service for creating a new API from an external API definition file.
Parameter Syntax
$result = $client->importRestApi([ 'body' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'failOnWarnings' => true || false, 'parameters' => ['<string>', ...], ]);
Parameter Details
Members
- body
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
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.
- failOnWarnings
-
- Type: boolean
A query parameter to indicate whether to rollback the API creation (
true
) or not (false
) when a warning is encountered. The default value isfalse
. - parameters
-
- Type: Associative array of custom strings keys (String) to strings
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
asignore=documentation
.To configure the endpoint type, set
parameters
asendpointConfigurationTypes=EDGE
,endpointConfigurationTypes=REGIONAL
, orendpointConfigurationTypes=PRIVATE
. The default endpoint type isEDGE
.To handle imported
basepath
, setparameters
asbasepath=ignore
,basepath=prepend
orbasepath=split
.
Result Syntax
[ 'apiKeySource' => 'HEADER|AUTHORIZER', 'binaryMediaTypes' => ['<string>', ...], 'createdDate' => <DateTime>, 'description' => '<string>', 'disableExecuteApiEndpoint' => true || false, 'endpointConfiguration' => [ 'types' => ['<string>', ...], 'vpcEndpointIds' => ['<string>', ...], ], 'id' => '<string>', 'minimumCompressionSize' => <integer>, 'name' => '<string>', 'policy' => '<string>', 'rootResourceId' => '<string>', 'tags' => ['<string>', ...], 'version' => '<string>', 'warnings' => ['<string>', ...], ]
Result Details
Members
- apiKeySource
-
- Type: string
The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer. - binaryMediaTypes
-
- Type: Array of strings
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the API was created.
- description
-
- Type: string
The API's description.
- disableExecuteApiEndpoint
-
- Type: boolean
Specifies whether clients can invoke your API by using the default
execute-api
endpoint. By default, clients can invoke your API with the defaulthttps://{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. - endpointConfiguration
-
- Type: EndpointConfiguration structure
The endpoint configuration of this RestApi showing the endpoint types of the API.
- id
-
- Type: string
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
- minimumCompressionSize
-
- Type: int
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.
- name
-
- Type: string
The API's name.
- policy
-
- Type: string
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
- rootResourceId
-
- Type: string
The API's root resource ID.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- version
-
- Type: string
A version identifier for the API.
- warnings
-
- Type: Array of strings
The warning messages reported when
failonwarnings
is turned on during API import.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
PutGatewayResponse
$result = $client->putGatewayResponse
([/* ... */]); $promise = $client->putGatewayResponseAsync
([/* ... */]);
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
Parameter Syntax
$result = $client->putGatewayResponse([ 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED|WAF_FILTERED', // REQUIRED 'restApiId' => '<string>', // REQUIRED 'statusCode' => '<string>', ]);
Parameter Details
Members
- responseParameters
-
- Type: Associative array of custom strings keys (String) to strings
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
- responseTemplates
-
- Type: Associative array of custom strings keys (String) to strings
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
- responseType
-
- Required: Yes
- Type: string
The response type of the associated GatewayResponse
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- statusCode
-
- Type: string
The HTTP status code of the GatewayResponse.
Result Syntax
[ 'defaultResponse' => true || false, 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED|WAF_FILTERED', 'statusCode' => '<string>', ]
Result Details
Members
- defaultResponse
-
- Type: boolean
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. - responseParameters
-
- Type: Associative array of custom strings keys (String) to strings
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
- responseTemplates
-
- Type: Associative array of custom strings keys (String) to strings
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
- responseType
-
- Type: string
The response type of the associated GatewayResponse.
- statusCode
-
- Type: string
The HTTP status code for this GatewayResponse.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
PutIntegration
$result = $client->putIntegration
([/* ... */]); $promise = $client->putIntegrationAsync
([/* ... */]);
Sets up a method's integration.
Parameter Syntax
$result = $client->putIntegration([ 'cacheKeyParameters' => ['<string>', ...], 'cacheNamespace' => '<string>', 'connectionId' => '<string>', 'connectionType' => 'INTERNET|VPC_LINK', 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'credentials' => '<string>', 'httpMethod' => '<string>', // REQUIRED 'integrationHttpMethod' => '<string>', 'passthroughBehavior' => '<string>', 'requestParameters' => ['<string>', ...], 'requestTemplates' => ['<string>', ...], 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED 'timeoutInMillis' => <integer>, 'tlsConfig' => [ 'insecureSkipVerification' => true || false, ], 'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY', // REQUIRED 'uri' => '<string>', ]);
Parameter Details
Members
- cacheKeyParameters
-
- Type: Array of strings
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
. - cacheNamespace
-
- Type: string
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources. - connectionId
-
- Type: string
The ID of the VpcLink used for the integration. Specify this value only if you specify
VPC_LINK
as the connection type. - connectionType
-
- Type: string
The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
. - contentHandling
-
- Type: string
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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. - credentials
-
- Type: string
Specifies whether credentials are required for a put integration.
- httpMethod
-
- Required: Yes
- Type: string
Specifies the HTTP method for the integration.
- integrationHttpMethod
-
- Type: string
The HTTP method for the integration.
- passthroughBehavior
-
- Type: string
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
, andNEVER
. - requestParameters
-
- Type: Associative array of custom strings keys (String) to strings
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}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name. - requestTemplates
-
- Type: Associative array of custom strings keys (String) to strings
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.
- resourceId
-
- Required: Yes
- Type: string
Specifies a put integration request's resource ID.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- timeoutInMillis
-
- Type: int
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
- tlsConfig
-
- Type: TlsConfig structure
Specifies the TLS configuration for an integration.
- type
-
- Required: Yes
- Type: string
Specifies a put integration input's type.
- uri
-
- Type: string
Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or
HTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, whereconnectionType
is notVPC_LINK
, or private integration, whereconnectionType
isVPC_LINK
. For a private HTTP integration, the URI is not used for routing. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api
}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API ofGetObject
, theuri
can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
.
Result Syntax
[ 'cacheKeyParameters' => ['<string>', ...], 'cacheNamespace' => '<string>', 'connectionId' => '<string>', 'connectionType' => 'INTERNET|VPC_LINK', 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'credentials' => '<string>', 'httpMethod' => '<string>', 'integrationResponses' => [ '<String>' => [ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ], // ... ], 'passthroughBehavior' => '<string>', 'requestParameters' => ['<string>', ...], 'requestTemplates' => ['<string>', ...], 'timeoutInMillis' => <integer>, 'tlsConfig' => [ 'insecureSkipVerification' => true || false, ], 'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY', 'uri' => '<string>', ]
Result Details
Members
- cacheKeyParameters
-
- Type: Array of strings
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
. - cacheNamespace
-
- Type: string
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources. - connectionId
-
- Type: string
The ID of the VpcLink used for the integration when
connectionType=VPC_LINK
and undefined, otherwise. - connectionType
-
- Type: string
The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
. - contentHandling
-
- Type: string
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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. - credentials
-
- Type: string
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 Amazon Web Services services, specify null. - httpMethod
-
- Type: string
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 toPOST
. For all other types, you must specify this property. - integrationResponses
-
- Type: Associative array of custom strings keys (String) to IntegrationResponse structures
Specifies the integration's responses.
- passthroughBehavior
-
- Type: string
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. - requestParameters
-
- Type: Associative array of custom strings keys (String) to strings
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}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name. - requestTemplates
-
- Type: Associative array of custom strings keys (String) to strings
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.
- timeoutInMillis
-
- Type: int
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
- tlsConfig
-
- Type: TlsConfig structure
Specifies the TLS configuration for an integration.
- type
-
- Type: string
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 aconnectionType
ofVPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC. - uri
-
- Type: string
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For
HTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. IfconnectionType
isVPC_LINK
specify the Network Load Balancer DNS name. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}
. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
PutIntegrationResponse
$result = $client->putIntegrationResponse
([/* ... */]); $promise = $client->putIntegrationResponseAsync
([/* ... */]);
Represents a put integration.
Parameter Syntax
$result = $client->putIntegrationResponse([ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'httpMethod' => '<string>', // REQUIRED 'resourceId' => '<string>', // REQUIRED 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'restApiId' => '<string>', // REQUIRED 'selectionPattern' => '<string>', 'statusCode' => '<string>', // REQUIRED ]);
Parameter Details
Members
- contentHandling
-
- Type: string
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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.
- httpMethod
-
- Required: Yes
- Type: string
Specifies a put integration response request's HTTP method.
- resourceId
-
- Required: Yes
- Type: string
Specifies a put integration response request's resource identifier.
- responseParameters
-
- Type: Associative array of custom strings keys (String) to strings
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}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
must be a valid and unique response header name andJSON-expression
a valid JSON expression without the$
prefix. - responseTemplates
-
- Type: Associative array of custom strings keys (String) to strings
Specifies a put integration response's templates.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- selectionPattern
-
- Type: string
Specifies the selection pattern of a put integration response.
- statusCode
-
- Required: Yes
- Type: string
Specifies the status code that is used to map the integration response to an existing MethodResponse.
Result Syntax
[ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ]
Result Details
Members
- contentHandling
-
- Type: string
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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.
- responseParameters
-
- Type: Associative array of custom strings keys (String) to strings
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}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
is a valid and unique response header name andJSON-expression
is a valid JSON expression without the$
prefix. - responseTemplates
-
- Type: Associative array of custom strings keys (String) to strings
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.
- selectionPattern
-
- Type: string
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 Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched. - statusCode
-
- Type: string
Specifies the status code that is used to map the integration response to an existing MethodResponse.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
PutMethod
$result = $client->putMethod
([/* ... */]); $promise = $client->putMethodAsync
([/* ... */]);
Add a method to an existing Resource resource.
Parameter Syntax
$result = $client->putMethod([ 'apiKeyRequired' => true || false, 'authorizationScopes' => ['<string>', ...], 'authorizationType' => '<string>', // REQUIRED 'authorizerId' => '<string>', 'httpMethod' => '<string>', // REQUIRED 'operationName' => '<string>', 'requestModels' => ['<string>', ...], 'requestParameters' => [true || false, ...], 'requestValidatorId' => '<string>', 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiKeyRequired
-
- Type: boolean
Specifies whether the method required a valid ApiKey.
- authorizationScopes
-
- Type: Array of strings
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. - authorizationType
-
- Required: Yes
- Type: string
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, orCOGNITO_USER_POOLS
for using a Cognito user pool. - authorizerId
-
- Type: string
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.
- httpMethod
-
- Required: Yes
- Type: string
Specifies the method request's HTTP method type.
- operationName
-
- Type: string
A human-friendly operation identifier for the method. For example, you can assign the
operationName
ofListPets
for theGET /pets
method in thePetStore
example. - requestModels
-
- Type: Associative array of custom strings keys (String) to strings
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.
- requestParameters
-
- Type: Associative array of custom strings keys (String) to booleans
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}
, wherelocation
isquerystring
,path
, orheader
andname
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. - requestValidatorId
-
- Type: string
The identifier of a RequestValidator for validating the method request.
- resourceId
-
- Required: Yes
- Type: string
The Resource identifier for the new Method resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'apiKeyRequired' => true || false, 'authorizationScopes' => ['<string>', ...], 'authorizationType' => '<string>', 'authorizerId' => '<string>', 'httpMethod' => '<string>', 'methodIntegration' => [ 'cacheKeyParameters' => ['<string>', ...], 'cacheNamespace' => '<string>', 'connectionId' => '<string>', 'connectionType' => 'INTERNET|VPC_LINK', 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'credentials' => '<string>', 'httpMethod' => '<string>', 'integrationResponses' => [ '<String>' => [ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ], // ... ], 'passthroughBehavior' => '<string>', 'requestParameters' => ['<string>', ...], 'requestTemplates' => ['<string>', ...], 'timeoutInMillis' => <integer>, 'tlsConfig' => [ 'insecureSkipVerification' => true || false, ], 'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY', 'uri' => '<string>', ], 'methodResponses' => [ '<String>' => [ 'responseModels' => ['<string>', ...], 'responseParameters' => [true || false, ...], 'statusCode' => '<string>', ], // ... ], 'operationName' => '<string>', 'requestModels' => ['<string>', ...], 'requestParameters' => [true || false, ...], 'requestValidatorId' => '<string>', ]
Result Details
Members
- apiKeyRequired
-
- Type: boolean
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
- authorizationScopes
-
- Type: Array of strings
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. - authorizationType
-
- Type: string
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, orCOGNITO_USER_POOLS
for using a Cognito user pool. - authorizerId
-
- Type: string
The identifier of an Authorizer to use on this method. The
authorizationType
must beCUSTOM
. - httpMethod
-
- Type: string
The method's HTTP verb.
- methodIntegration
-
- Type: Integration structure
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.
- methodResponses
-
- Type: Associative array of custom strings keys (String) to MethodResponse structures
Gets a method response associated with a given HTTP status code.
- operationName
-
- Type: string
A human-friendly operation identifier for the method. For example, you can assign the
operationName
ofListPets
for theGET /pets
method in thePetStore
example. - requestModels
-
- Type: Associative array of custom strings keys (String) to strings
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).
- requestParameters
-
- Type: Associative array of custom strings keys (String) to booleans
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}
, wherelocation
isquerystring
,path
, orheader
andname
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. - requestValidatorId
-
- Type: string
The identifier of a RequestValidator for request validation.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
PutMethodResponse
$result = $client->putMethodResponse
([/* ... */]); $promise = $client->putMethodResponseAsync
([/* ... */]);
Adds a MethodResponse to an existing Method resource.
Parameter Syntax
$result = $client->putMethodResponse([ 'httpMethod' => '<string>', // REQUIRED 'resourceId' => '<string>', // REQUIRED 'responseModels' => ['<string>', ...], 'responseParameters' => [true || false, ...], 'restApiId' => '<string>', // REQUIRED 'statusCode' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
The HTTP verb of the Method resource.
- resourceId
-
- Required: Yes
- Type: string
The Resource identifier for the Method resource.
- responseModels
-
- Type: Associative array of custom strings keys (String) to strings
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.
- responseParameters
-
- Type: Associative array of custom strings keys (String) to booleans
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}
, wherename
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 inintegration.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 ofintegration.response.body.{JSON-expression}
, whereJSON-expression
is a valid JSON expression without the$
prefix.) - restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- statusCode
-
- Required: Yes
- Type: string
The method response's status code.
Result Syntax
[ 'responseModels' => ['<string>', ...], 'responseParameters' => [true || false, ...], 'statusCode' => '<string>', ]
Result Details
Members
- responseModels
-
- Type: Associative array of custom strings keys (String) to strings
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.
- responseParameters
-
- Type: Associative array of custom strings keys (String) to booleans
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}
, wherename
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 inintegration.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 ofintegration.response.body.{JSON-expression}
, whereJSON-expression
is a valid JSON expression without the$
prefix.) - statusCode
-
- Type: string
The method response's status code.
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
PutRestApi
$result = $client->putRestApi
([/* ... */]); $promise = $client->putRestApiAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->putRestApi([ 'body' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'failOnWarnings' => true || false, 'mode' => 'merge|overwrite', 'parameters' => ['<string>', ...], 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- body
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
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.
- failOnWarnings
-
- Type: boolean
A query parameter to indicate whether to rollback the API update (
true
) or not (false
) when a warning is encountered. The default value isfalse
. - mode
-
- Type: string
The
mode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge". - parameters
-
- Type: Associative array of custom strings keys (String) to strings
Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set
ignore=documentation
as aparameters
value, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
. - restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'apiKeySource' => 'HEADER|AUTHORIZER', 'binaryMediaTypes' => ['<string>', ...], 'createdDate' => <DateTime>, 'description' => '<string>', 'disableExecuteApiEndpoint' => true || false, 'endpointConfiguration' => [ 'types' => ['<string>', ...], 'vpcEndpointIds' => ['<string>', ...], ], 'id' => '<string>', 'minimumCompressionSize' => <integer>, 'name' => '<string>', 'policy' => '<string>', 'rootResourceId' => '<string>', 'tags' => ['<string>', ...], 'version' => '<string>', 'warnings' => ['<string>', ...], ]
Result Details
Members
- apiKeySource
-
- Type: string
The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer. - binaryMediaTypes
-
- Type: Array of strings
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the API was created.
- description
-
- Type: string
The API's description.
- disableExecuteApiEndpoint
-
- Type: boolean
Specifies whether clients can invoke your API by using the default
execute-api
endpoint. By default, clients can invoke your API with the defaulthttps://{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. - endpointConfiguration
-
- Type: EndpointConfiguration structure
The endpoint configuration of this RestApi showing the endpoint types of the API.
- id
-
- Type: string
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
- minimumCompressionSize
-
- Type: int
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.
- name
-
- Type: string
The API's name.
- policy
-
- Type: string
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
- rootResourceId
-
- Type: string
The API's root resource ID.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- version
-
- Type: string
A version identifier for the API.
- warnings
-
- Type: Array of strings
The warning messages reported when
failonwarnings
is turned on during API import.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
RejectDomainNameAccessAssociation
$result = $client->rejectDomainNameAccessAssociation
([/* ... */]); $promise = $client->rejectDomainNameAccessAssociationAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->rejectDomainNameAccessAssociation([ 'domainNameAccessAssociationArn' => '<string>', // REQUIRED 'domainNameArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- domainNameAccessAssociationArn
-
- Required: Yes
- Type: string
The ARN of the domain name access association resource.
- domainNameArn
-
- Required: Yes
- Type: string
The ARN of the domain name.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Adds or updates a tag on a given resource.
Parameter Syntax
$result = $client->tagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of a resource that can be tagged.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to strings
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
TestInvokeAuthorizer
$result = $client->testInvokeAuthorizer
([/* ... */]); $promise = $client->testInvokeAuthorizerAsync
([/* ... */]);
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
Parameter Syntax
$result = $client->testInvokeAuthorizer([ 'additionalContext' => ['<string>', ...], 'authorizerId' => '<string>', // REQUIRED 'body' => '<string>', 'headers' => ['<string>', ...], 'multiValueHeaders' => [ '<String>' => ['<string>', ...], // ... ], 'pathWithQueryString' => '<string>', 'restApiId' => '<string>', // REQUIRED 'stageVariables' => ['<string>', ...], ]);
Parameter Details
Members
- additionalContext
-
- Type: Associative array of custom strings keys (String) to strings
A key-value map of additional context variables.
- authorizerId
-
- Required: Yes
- Type: string
Specifies a test invoke authorizer request's Authorizer ID.
- body
-
- Type: string
The simulated request body of an incoming invocation request.
- headers
-
- Type: Associative array of custom strings keys (String) to strings
A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
- multiValueHeaders
-
- Type: Associative array of custom strings keys (String) to stringss
The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
- pathWithQueryString
-
- Type: string
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- stageVariables
-
- Type: Associative array of custom strings keys (String) to strings
A key-value map of stage variables to simulate an invocation on a deployed Stage.
Result Syntax
[ 'authorization' => [ '<String>' => ['<string>', ...], // ... ], 'claims' => ['<string>', ...], 'clientStatus' => <integer>, 'latency' => <integer>, 'log' => '<string>', 'policy' => '<string>', 'principalId' => '<string>', ]
Result Details
Members
- authorization
-
- Type: Associative array of custom strings keys (String) to stringss
The authorization response.
- claims
-
- Type: Associative array of custom strings keys (String) to strings
The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
- clientStatus
-
- Type: int
The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
- latency
-
- Type: long (int|float)
The execution latency, in ms, of the test authorizer request.
- log
-
- Type: string
The API Gateway execution log for the test authorizer request.
- policy
-
- Type: string
The JSON policy document returned by the Authorizer
- principalId
-
- Type: string
The principal identity returned by the Authorizer
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
TestInvokeMethod
$result = $client->testInvokeMethod
([/* ... */]); $promise = $client->testInvokeMethodAsync
([/* ... */]);
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
Parameter Syntax
$result = $client->testInvokeMethod([ 'body' => '<string>', 'clientCertificateId' => '<string>', 'headers' => ['<string>', ...], 'httpMethod' => '<string>', // REQUIRED 'multiValueHeaders' => [ '<String>' => ['<string>', ...], // ... ], 'pathWithQueryString' => '<string>', 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED 'stageVariables' => ['<string>', ...], ]);
Parameter Details
Members
- body
-
- Type: string
The simulated request body of an incoming invocation request.
- clientCertificateId
-
- Type: string
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.
- headers
-
- Type: Associative array of custom strings keys (String) to strings
A key-value map of headers to simulate an incoming invocation request.
- httpMethod
-
- Required: Yes
- Type: string
Specifies a test invoke method request's HTTP method.
- multiValueHeaders
-
- Type: Associative array of custom strings keys (String) to stringss
The headers as a map from string to list of values to simulate an incoming invocation request.
- pathWithQueryString
-
- Type: string
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
- resourceId
-
- Required: Yes
- Type: string
Specifies a test invoke method request's resource ID.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- stageVariables
-
- Type: Associative array of custom strings keys (String) to strings
A key-value map of stage variables to simulate an invocation on a deployed Stage.
Result Syntax
[ 'body' => '<string>', 'headers' => ['<string>', ...], 'latency' => <integer>, 'log' => '<string>', 'multiValueHeaders' => [ '<String>' => ['<string>', ...], // ... ], 'status' => <integer>, ]
Result Details
Members
- body
-
- Type: string
The body of the HTTP response.
- headers
-
- Type: Associative array of custom strings keys (String) to strings
The headers of the HTTP response.
- latency
-
- Type: long (int|float)
The execution latency, in ms, of the test invoke request.
- log
-
- Type: string
The API Gateway execution log for the test invoke request.
- multiValueHeaders
-
- Type: Associative array of custom strings keys (String) to stringss
The headers of the HTTP response as a map from string to list of values.
- status
-
- Type: int
The HTTP status code.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes a tag from a given resource.
Parameter Syntax
$result = $client->untagResource([ 'resourceArn' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of a resource that can be tagged.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The Tag keys to delete.
Result Syntax
[]
Result Details
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateAccount
$result = $client->updateAccount
([/* ... */]); $promise = $client->updateAccountAsync
([/* ... */]);
Changes information about the current Account resource.
Parameter Syntax
$result = $client->updateAccount([ 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
Result Syntax
[ 'apiKeyVersion' => '<string>', 'cloudwatchRoleArn' => '<string>', 'features' => ['<string>', ...], 'throttleSettings' => [ 'burstLimit' => <integer>, 'rateLimit' => <float>, ], ]
Result Details
Members
- apiKeyVersion
-
- Type: string
The version of the API keys used for the account.
- cloudwatchRoleArn
-
- Type: string
The ARN of an Amazon CloudWatch role for the current Account.
- features
-
- Type: Array of strings
A list of features supported for the account. When usage plans are enabled, the features list will include an entry of
"UsagePlans"
. - throttleSettings
-
- Type: ThrottleSettings structure
Specifies the API request limits configured for the current Account.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateApiKey
$result = $client->updateApiKey
([/* ... */]); $promise = $client->updateApiKeyAsync
([/* ... */]);
Changes information about an ApiKey resource.
Parameter Syntax
$result = $client->updateApiKey([ 'apiKey' => '<string>', // REQUIRED 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- apiKey
-
- Required: Yes
- Type: string
The identifier of the ApiKey resource to be updated.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
Result Syntax
[ 'createdDate' => <DateTime>, 'customerId' => '<string>', 'description' => '<string>', 'enabled' => true || false, 'id' => '<string>', 'lastUpdatedDate' => <DateTime>, 'name' => '<string>', 'stageKeys' => ['<string>', ...], 'tags' => ['<string>', ...], 'value' => '<string>', ]
Result Details
Members
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the API Key was created.
- customerId
-
- Type: string
An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
- description
-
- Type: string
The description of the API Key.
- enabled
-
- Type: boolean
Specifies whether the API Key can be used by callers.
- id
-
- Type: string
The identifier of the API Key.
- lastUpdatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the API Key was last updated.
- name
-
- Type: string
The name of the API Key.
- stageKeys
-
- Type: Array of strings
A list of Stage resources that are associated with the ApiKey resource.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- value
-
- Type: string
The value of the API Key.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateAuthorizer
$result = $client->updateAuthorizer
([/* ... */]); $promise = $client->updateAuthorizerAsync
([/* ... */]);
Updates an existing Authorizer resource.
Parameter Syntax
$result = $client->updateAuthorizer([ 'authorizerId' => '<string>', // REQUIRED 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- authorizerId
-
- Required: Yes
- Type: string
The identifier of the Authorizer resource.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'authType' => '<string>', 'authorizerCredentials' => '<string>', 'authorizerResultTtlInSeconds' => <integer>, 'authorizerUri' => '<string>', 'id' => '<string>', 'identitySource' => '<string>', 'identityValidationExpression' => '<string>', 'name' => '<string>', 'providerARNs' => ['<string>', ...], 'type' => 'TOKEN|REQUEST|COGNITO_USER_POOLS', ]
Result Details
Members
- authType
-
- Type: string
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
- authorizerCredentials
-
- Type: string
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.
- authorizerResultTtlInSeconds
-
- Type: int
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.
- authorizerUri
-
- Type: string
Specifies the authorizer's Uniform Resource Identifier (URI). For
TOKEN
orREQUEST
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 formarn: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
. - id
-
- Type: string
The identifier for the authorizer resource.
- identitySource
-
- Type: string
The identity source for which authorization is requested. For a
TOKEN
orCOGNITO_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 isAuth
, the header mapping expression ismethod.request.header.Auth
. For theREQUEST
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 anAuth
header, aName
query string parameter are defined as identity sources, this value ismethod.request.header.Auth
,method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional. - identityValidationExpression
-
- Type: string
A validation expression for the incoming identity token. For
TOKEN
authorizers, this value is a regular expression. ForCOGNITO_USER_POOLS
authorizers, API Gateway will match theaud
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 theREQUEST
authorizer. - name
-
- Type: string
The name of the authorizer.
- providerARNs
-
- Type: Array of strings
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 aTOKEN
orREQUEST
authorizer, this is not defined. - type
-
- Type: string
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, andCOGNITO_USER_POOLS
for using an Amazon Cognito user pool.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateBasePathMapping
$result = $client->updateBasePathMapping
([/* ... */]); $promise = $client->updateBasePathMappingAsync
([/* ... */]);
Changes information about the BasePathMapping resource.
Parameter Syntax
$result = $client->updateBasePathMapping([ 'basePath' => '<string>', // REQUIRED 'domainName' => '<string>', // REQUIRED 'domainNameId' => '<string>', 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- basePath
-
- Required: Yes
- Type: string
The base path of the BasePathMapping resource to change.
To specify an empty base path, set this parameter to
'(none)'
. - domainName
-
- Required: Yes
- Type: string
The domain name of the BasePathMapping resource to change.
- domainNameId
-
- Type: string
The identifier for the domain name resource. Supported only for private custom domain names.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
Result Syntax
[ 'basePath' => '<string>', 'restApiId' => '<string>', 'stage' => '<string>', ]
Result Details
Members
- basePath
-
- Type: string
The base path name that callers of the API must provide as part of the URL after the domain name.
- restApiId
-
- Type: string
The string identifier of the associated RestApi.
- stage
-
- Type: string
The name of the associated stage.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateClientCertificate
$result = $client->updateClientCertificate
([/* ... */]); $promise = $client->updateClientCertificateAsync
([/* ... */]);
Changes information about an ClientCertificate resource.
Parameter Syntax
$result = $client->updateClientCertificate([ 'clientCertificateId' => '<string>', // REQUIRED 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- clientCertificateId
-
- Required: Yes
- Type: string
The identifier of the ClientCertificate resource to be updated.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
Result Syntax
[ 'clientCertificateId' => '<string>', 'createdDate' => <DateTime>, 'description' => '<string>', 'expirationDate' => <DateTime>, 'pemEncodedCertificate' => '<string>', 'tags' => ['<string>', ...], ]
Result Details
Members
- clientCertificateId
-
- Type: string
The identifier of the client certificate.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the client certificate was created.
- description
-
- Type: string
The description of the client certificate.
- expirationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the client certificate will expire.
- pemEncodedCertificate
-
- Type: string
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateDeployment
$result = $client->updateDeployment
([/* ... */]); $promise = $client->updateDeploymentAsync
([/* ... */]);
Changes information about a Deployment resource.
Parameter Syntax
$result = $client->updateDeployment([ 'deploymentId' => '<string>', // REQUIRED 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- deploymentId
-
- Required: Yes
- Type: string
The replacement identifier for the Deployment resource to change information about.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'apiSummary' => [ '<String>' => [ '<String>' => [ 'apiKeyRequired' => true || false, 'authorizationType' => '<string>', ], // ... ], // ... ], 'createdDate' => <DateTime>, 'description' => '<string>', 'id' => '<string>', ]
Result Details
Members
- apiSummary
-
- Type: Associative array of custom strings keys (String) to MethodSnapshot structuress
A summary of the RestApi at the date and time that the deployment resource was created.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the deployment resource was created.
- description
-
- Type: string
The description for the deployment resource.
- id
-
- Type: string
The identifier for the deployment resource.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
- ServiceUnavailableException:
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
UpdateDocumentationPart
$result = $client->updateDocumentationPart
([/* ... */]); $promise = $client->updateDocumentationPartAsync
([/* ... */]);
Updates a documentation part.
Parameter Syntax
$result = $client->updateDocumentationPart([ 'documentationPartId' => '<string>', // REQUIRED 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- documentationPartId
-
- Required: Yes
- Type: string
The identifier of the to-be-updated documentation part.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'id' => '<string>', 'location' => [ 'method' => '<string>', 'name' => '<string>', 'path' => '<string>', 'statusCode' => '<string>', 'type' => 'API|AUTHORIZER|MODEL|RESOURCE|METHOD|PATH_PARAMETER|QUERY_PARAMETER|REQUEST_HEADER|REQUEST_BODY|RESPONSE|RESPONSE_HEADER|RESPONSE_BODY', ], 'properties' => '<string>', ]
Result Details
Members
- id
-
- Type: string
The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart
is created. - location
-
- Type: DocumentationPartLocation structure
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.
- properties
-
- Type: string
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 ofx-amazon-apigateway-documentation
.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateDocumentationVersion
$result = $client->updateDocumentationVersion
([/* ... */]); $promise = $client->updateDocumentationVersionAsync
([/* ... */]);
Updates a documentation version.
Parameter Syntax
$result = $client->updateDocumentationVersion([ 'documentationVersion' => '<string>', // REQUIRED 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- documentationVersion
-
- Required: Yes
- Type: string
The version identifier of the to-be-updated documentation version.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'createdDate' => <DateTime>, 'description' => '<string>', 'version' => '<string>', ]
Result Details
Members
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date when the API documentation snapshot is created.
- description
-
- Type: string
The description of the API documentation snapshot.
- version
-
- Type: string
The version identifier of the API documentation snapshot.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateDomainName
$result = $client->updateDomainName
([/* ... */]); $promise = $client->updateDomainNameAsync
([/* ... */]);
Changes information about the DomainName resource.
Parameter Syntax
$result = $client->updateDomainName([ 'domainName' => '<string>', // REQUIRED 'domainNameId' => '<string>', 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- domainName
-
- Required: Yes
- Type: string
The name of the DomainName resource to be changed.
- domainNameId
-
- Type: string
The identifier for the domain name resource. Supported only for private custom domain names.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
Result Syntax
[ 'certificateArn' => '<string>', 'certificateName' => '<string>', 'certificateUploadDate' => <DateTime>, 'distributionDomainName' => '<string>', 'distributionHostedZoneId' => '<string>', 'domainName' => '<string>', 'domainNameArn' => '<string>', 'domainNameId' => '<string>', 'domainNameStatus' => 'AVAILABLE|UPDATING|PENDING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION', 'domainNameStatusMessage' => '<string>', 'endpointConfiguration' => [ '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>', 'securityPolicy' => 'TLS_1_0|TLS_1_2', 'tags' => ['<string>', ...], ]
Result Details
Members
- certificateArn
-
- Type: string
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.
- certificateName
-
- Type: string
The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
- certificateUploadDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.
- distributionDomainName
-
- Type: string
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.
- distributionHostedZoneId
-
- Type: string
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. - domainName
-
- Type: string
The custom domain name as an API host name, for example,
my-api.example.com
. - domainNameArn
-
- Type: string
The ARN of the domain name. Supported only for private custom domain names.
- domainNameId
-
- Type: string
The identifier for the domain name resource. Supported only for private custom domain names.
- domainNameStatus
-
- Type: string
The status of the DomainName migration. The valid values are
AVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, the domain can be updated. - domainNameStatusMessage
-
- Type: string
An optional text message containing detailed information about status of the DomainName migration.
- endpointConfiguration
-
- Type: EndpointConfiguration structure
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
- managementPolicy
-
- Type: string
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.
- mutualTlsAuthentication
-
- Type: MutualTlsAuthentication structure
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.
- ownershipVerificationCertificateArn
-
- Type: string
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.
- policy
-
- Type: string
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. - regionalCertificateArn
-
- Type: string
The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
- regionalCertificateName
-
- Type: string
The name of the certificate that will be used for validating the regional domain name.
- regionalDomainName
-
- Type: string
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.
- regionalHostedZoneId
-
- Type: string
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.
- securityPolicy
-
- Type: string
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
. - tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateGatewayResponse
$result = $client->updateGatewayResponse
([/* ... */]); $promise = $client->updateGatewayResponseAsync
([/* ... */]);
Updates a GatewayResponse of a specified response type on the given RestApi.
Parameter Syntax
$result = $client->updateGatewayResponse([ 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED|WAF_FILTERED', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- responseType
-
- Required: Yes
- Type: string
The response type of the associated GatewayResponse.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'defaultResponse' => true || false, 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'responseType' => 'DEFAULT_4XX|DEFAULT_5XX|RESOURCE_NOT_FOUND|UNAUTHORIZED|INVALID_API_KEY|ACCESS_DENIED|AUTHORIZER_FAILURE|AUTHORIZER_CONFIGURATION_ERROR|INVALID_SIGNATURE|EXPIRED_TOKEN|MISSING_AUTHENTICATION_TOKEN|INTEGRATION_FAILURE|INTEGRATION_TIMEOUT|API_CONFIGURATION_ERROR|UNSUPPORTED_MEDIA_TYPE|BAD_REQUEST_PARAMETERS|BAD_REQUEST_BODY|REQUEST_TOO_LARGE|THROTTLED|QUOTA_EXCEEDED|WAF_FILTERED', 'statusCode' => '<string>', ]
Result Details
Members
- defaultResponse
-
- Type: boolean
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. - responseParameters
-
- Type: Associative array of custom strings keys (String) to strings
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
- responseTemplates
-
- Type: Associative array of custom strings keys (String) to strings
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
- responseType
-
- Type: string
The response type of the associated GatewayResponse.
- statusCode
-
- Type: string
The HTTP status code for this GatewayResponse.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateIntegration
$result = $client->updateIntegration
([/* ... */]); $promise = $client->updateIntegrationAsync
([/* ... */]);
Represents an update integration.
Parameter Syntax
$result = $client->updateIntegration([ 'httpMethod' => '<string>', // REQUIRED 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
Represents an update integration request's HTTP method.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- resourceId
-
- Required: Yes
- Type: string
Represents an update integration request's resource identifier.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'cacheKeyParameters' => ['<string>', ...], 'cacheNamespace' => '<string>', 'connectionId' => '<string>', 'connectionType' => 'INTERNET|VPC_LINK', 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'credentials' => '<string>', 'httpMethod' => '<string>', 'integrationResponses' => [ '<String>' => [ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ], // ... ], 'passthroughBehavior' => '<string>', 'requestParameters' => ['<string>', ...], 'requestTemplates' => ['<string>', ...], 'timeoutInMillis' => <integer>, 'tlsConfig' => [ 'insecureSkipVerification' => true || false, ], 'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY', 'uri' => '<string>', ]
Result Details
Members
- cacheKeyParameters
-
- Type: Array of strings
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
. - cacheNamespace
-
- Type: string
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources. - connectionId
-
- Type: string
The ID of the VpcLink used for the integration when
connectionType=VPC_LINK
and undefined, otherwise. - connectionType
-
- Type: string
The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
. - contentHandling
-
- Type: string
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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. - credentials
-
- Type: string
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 Amazon Web Services services, specify null. - httpMethod
-
- Type: string
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 toPOST
. For all other types, you must specify this property. - integrationResponses
-
- Type: Associative array of custom strings keys (String) to IntegrationResponse structures
Specifies the integration's responses.
- passthroughBehavior
-
- Type: string
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. - requestParameters
-
- Type: Associative array of custom strings keys (String) to strings
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}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name. - requestTemplates
-
- Type: Associative array of custom strings keys (String) to strings
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.
- timeoutInMillis
-
- Type: int
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
- tlsConfig
-
- Type: TlsConfig structure
Specifies the TLS configuration for an integration.
- type
-
- Type: string
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 aconnectionType
ofVPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC. - uri
-
- Type: string
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For
HTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. IfconnectionType
isVPC_LINK
specify the Network Load Balancer DNS name. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}
. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateIntegrationResponse
$result = $client->updateIntegrationResponse
([/* ... */]); $promise = $client->updateIntegrationResponseAsync
([/* ... */]);
Represents an update integration response.
Parameter Syntax
$result = $client->updateIntegrationResponse([ 'httpMethod' => '<string>', // REQUIRED 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED 'statusCode' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
Specifies an update integration response request's HTTP method.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- resourceId
-
- Required: Yes
- Type: string
Specifies an update integration response request's resource identifier.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- statusCode
-
- Required: Yes
- Type: string
Specifies an update integration response request's status code.
Result Syntax
[ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ]
Result Details
Members
- contentHandling
-
- Type: string
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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.
- responseParameters
-
- Type: Associative array of custom strings keys (String) to strings
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}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
is a valid and unique response header name andJSON-expression
is a valid JSON expression without the$
prefix. - responseTemplates
-
- Type: Associative array of custom strings keys (String) to strings
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.
- selectionPattern
-
- Type: string
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 Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched. - statusCode
-
- Type: string
Specifies the status code that is used to map the integration response to an existing MethodResponse.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateMethod
$result = $client->updateMethod
([/* ... */]); $promise = $client->updateMethodAsync
([/* ... */]);
Updates an existing Method resource.
Parameter Syntax
$result = $client->updateMethod([ 'httpMethod' => '<string>', // REQUIRED 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
The HTTP verb of the Method resource.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- resourceId
-
- Required: Yes
- Type: string
The Resource identifier for the Method resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'apiKeyRequired' => true || false, 'authorizationScopes' => ['<string>', ...], 'authorizationType' => '<string>', 'authorizerId' => '<string>', 'httpMethod' => '<string>', 'methodIntegration' => [ 'cacheKeyParameters' => ['<string>', ...], 'cacheNamespace' => '<string>', 'connectionId' => '<string>', 'connectionType' => 'INTERNET|VPC_LINK', 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'credentials' => '<string>', 'httpMethod' => '<string>', 'integrationResponses' => [ '<String>' => [ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ], // ... ], 'passthroughBehavior' => '<string>', 'requestParameters' => ['<string>', ...], 'requestTemplates' => ['<string>', ...], 'timeoutInMillis' => <integer>, 'tlsConfig' => [ 'insecureSkipVerification' => true || false, ], 'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY', 'uri' => '<string>', ], 'methodResponses' => [ '<String>' => [ 'responseModels' => ['<string>', ...], 'responseParameters' => [true || false, ...], 'statusCode' => '<string>', ], // ... ], 'operationName' => '<string>', 'requestModels' => ['<string>', ...], 'requestParameters' => [true || false, ...], 'requestValidatorId' => '<string>', ]
Result Details
Members
- apiKeyRequired
-
- Type: boolean
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
- authorizationScopes
-
- Type: Array of strings
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. - authorizationType
-
- Type: string
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, orCOGNITO_USER_POOLS
for using a Cognito user pool. - authorizerId
-
- Type: string
The identifier of an Authorizer to use on this method. The
authorizationType
must beCUSTOM
. - httpMethod
-
- Type: string
The method's HTTP verb.
- methodIntegration
-
- Type: Integration structure
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.
- methodResponses
-
- Type: Associative array of custom strings keys (String) to MethodResponse structures
Gets a method response associated with a given HTTP status code.
- operationName
-
- Type: string
A human-friendly operation identifier for the method. For example, you can assign the
operationName
ofListPets
for theGET /pets
method in thePetStore
example. - requestModels
-
- Type: Associative array of custom strings keys (String) to strings
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).
- requestParameters
-
- Type: Associative array of custom strings keys (String) to booleans
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}
, wherelocation
isquerystring
,path
, orheader
andname
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. - requestValidatorId
-
- Type: string
The identifier of a RequestValidator for request validation.
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateMethodResponse
$result = $client->updateMethodResponse
([/* ... */]); $promise = $client->updateMethodResponseAsync
([/* ... */]);
Updates an existing MethodResponse resource.
Parameter Syntax
$result = $client->updateMethodResponse([ 'httpMethod' => '<string>', // REQUIRED 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED 'statusCode' => '<string>', // REQUIRED ]);
Parameter Details
Members
- httpMethod
-
- Required: Yes
- Type: string
The HTTP verb of the Method resource.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- resourceId
-
- Required: Yes
- Type: string
The Resource identifier for the MethodResponse resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- statusCode
-
- Required: Yes
- Type: string
The status code for the MethodResponse resource.
Result Syntax
[ 'responseModels' => ['<string>', ...], 'responseParameters' => [true || false, ...], 'statusCode' => '<string>', ]
Result Details
Members
- responseModels
-
- Type: Associative array of custom strings keys (String) to strings
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.
- responseParameters
-
- Type: Associative array of custom strings keys (String) to booleans
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}
, wherename
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 inintegration.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 ofintegration.response.body.{JSON-expression}
, whereJSON-expression
is a valid JSON expression without the$
prefix.) - statusCode
-
- Type: string
The method response's status code.
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateModel
$result = $client->updateModel
([/* ... */]); $promise = $client->updateModelAsync
([/* ... */]);
Changes information about a model. The maximum size of the model is 400 KB.
Parameter Syntax
$result = $client->updateModel([ 'modelName' => '<string>', // REQUIRED 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- modelName
-
- Required: Yes
- Type: string
The name of the model to update.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'contentType' => '<string>', 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'schema' => '<string>', ]
Result Details
Members
- contentType
-
- Type: string
The content-type for the model.
- description
-
- Type: string
The description of the model.
- id
-
- Type: string
The identifier for the model resource.
- name
-
- Type: string
The name of the model. Must be an alphanumeric string.
- schema
-
- Type: string
The schema for the model. For
application/json
models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateRequestValidator
$result = $client->updateRequestValidator
([/* ... */]); $promise = $client->updateRequestValidatorAsync
([/* ... */]);
Updates a RequestValidator of a given RestApi.
Parameter Syntax
$result = $client->updateRequestValidator([ 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'requestValidatorId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- requestValidatorId
-
- Required: Yes
- Type: string
The identifier of RequestValidator to be updated.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'id' => '<string>', 'name' => '<string>', 'validateRequestBody' => true || false, 'validateRequestParameters' => true || false, ]
Result Details
Members
- id
-
- Type: string
The identifier of this RequestValidator.
- name
-
- Type: string
The name of this RequestValidator
- validateRequestBody
-
- Type: boolean
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
- validateRequestParameters
-
- Type: boolean
A Boolean flag to indicate whether to validate request parameters (
true
) or not (false
).
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateResource
$result = $client->updateResource
([/* ... */]); $promise = $client->updateResourceAsync
([/* ... */]);
Changes information about a Resource resource.
Parameter Syntax
$result = $client->updateResource([ 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'resourceId' => '<string>', // REQUIRED 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- resourceId
-
- Required: Yes
- Type: string
The identifier of the Resource resource.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'id' => '<string>', 'parentId' => '<string>', 'path' => '<string>', 'pathPart' => '<string>', 'resourceMethods' => [ '<String>' => [ 'apiKeyRequired' => true || false, 'authorizationScopes' => ['<string>', ...], 'authorizationType' => '<string>', 'authorizerId' => '<string>', 'httpMethod' => '<string>', 'methodIntegration' => [ 'cacheKeyParameters' => ['<string>', ...], 'cacheNamespace' => '<string>', 'connectionId' => '<string>', 'connectionType' => 'INTERNET|VPC_LINK', 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'credentials' => '<string>', 'httpMethod' => '<string>', 'integrationResponses' => [ '<String>' => [ 'contentHandling' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT', 'responseParameters' => ['<string>', ...], 'responseTemplates' => ['<string>', ...], 'selectionPattern' => '<string>', 'statusCode' => '<string>', ], // ... ], 'passthroughBehavior' => '<string>', 'requestParameters' => ['<string>', ...], 'requestTemplates' => ['<string>', ...], 'timeoutInMillis' => <integer>, 'tlsConfig' => [ 'insecureSkipVerification' => true || false, ], 'type' => 'HTTP|AWS|MOCK|HTTP_PROXY|AWS_PROXY', 'uri' => '<string>', ], 'methodResponses' => [ '<String>' => [ 'responseModels' => ['<string>', ...], 'responseParameters' => [true || false, ...], 'statusCode' => '<string>', ], // ... ], 'operationName' => '<string>', 'requestModels' => ['<string>', ...], 'requestParameters' => [true || false, ...], 'requestValidatorId' => '<string>', ], // ... ], ]
Result Details
Members
- id
-
- Type: string
The resource's identifier.
- parentId
-
- Type: string
The parent resource's identifier.
- path
-
- Type: string
The full path for this resource.
- pathPart
-
- Type: string
The last path segment for this resource.
- resourceMethods
-
- Type: Associative array of custom strings keys (String) to Method structures
Gets an API resource's method of a given HTTP verb.
Errors
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateRestApi
$result = $client->updateRestApi
([/* ... */]); $promise = $client->updateRestApiAsync
([/* ... */]);
Changes information about the specified API.
Parameter Syntax
$result = $client->updateRestApi([ 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'restApiId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
Result Syntax
[ 'apiKeySource' => 'HEADER|AUTHORIZER', 'binaryMediaTypes' => ['<string>', ...], 'createdDate' => <DateTime>, 'description' => '<string>', 'disableExecuteApiEndpoint' => true || false, 'endpointConfiguration' => [ 'types' => ['<string>', ...], 'vpcEndpointIds' => ['<string>', ...], ], 'id' => '<string>', 'minimumCompressionSize' => <integer>, 'name' => '<string>', 'policy' => '<string>', 'rootResourceId' => '<string>', 'tags' => ['<string>', ...], 'version' => '<string>', 'warnings' => ['<string>', ...], ]
Result Details
Members
- apiKeySource
-
- Type: string
The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer. - binaryMediaTypes
-
- Type: Array of strings
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the API was created.
- description
-
- Type: string
The API's description.
- disableExecuteApiEndpoint
-
- Type: boolean
Specifies whether clients can invoke your API by using the default
execute-api
endpoint. By default, clients can invoke your API with the defaulthttps://{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. - endpointConfiguration
-
- Type: EndpointConfiguration structure
The endpoint configuration of this RestApi showing the endpoint types of the API.
- id
-
- Type: string
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
- minimumCompressionSize
-
- Type: int
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.
- name
-
- Type: string
The API's name.
- policy
-
- Type: string
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
- rootResourceId
-
- Type: string
The API's root resource ID.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- version
-
- Type: string
A version identifier for the API.
- warnings
-
- Type: Array of strings
The warning messages reported when
failonwarnings
is turned on during API import.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateStage
$result = $client->updateStage
([/* ... */]); $promise = $client->updateStageAsync
([/* ... */]);
Changes information about a Stage resource.
Parameter Syntax
$result = $client->updateStage([ 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'restApiId' => '<string>', // REQUIRED 'stageName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- restApiId
-
- Required: Yes
- Type: string
The string identifier of the associated RestApi.
- stageName
-
- Required: Yes
- Type: string
The name of the Stage resource to change information about.
Result Syntax
[ 'accessLogSettings' => [ 'destinationArn' => '<string>', 'format' => '<string>', ], 'cacheClusterEnabled' => true || false, 'cacheClusterSize' => '0.5|1.6|6.1|13.5|28.4|58.2|118|237', 'cacheClusterStatus' => 'CREATE_IN_PROGRESS|AVAILABLE|DELETE_IN_PROGRESS|NOT_AVAILABLE|FLUSH_IN_PROGRESS', 'canarySettings' => [ 'deploymentId' => '<string>', 'percentTraffic' => <float>, 'stageVariableOverrides' => ['<string>', ...], 'useStageCache' => true || false, ], 'clientCertificateId' => '<string>', 'createdDate' => <DateTime>, 'deploymentId' => '<string>', 'description' => '<string>', 'documentationVersion' => '<string>', 'lastUpdatedDate' => <DateTime>, 'methodSettings' => [ '<String>' => [ 'cacheDataEncrypted' => true || false, 'cacheTtlInSeconds' => <integer>, 'cachingEnabled' => true || false, 'dataTraceEnabled' => true || false, 'loggingLevel' => '<string>', 'metricsEnabled' => true || false, 'requireAuthorizationForCacheControl' => true || false, 'throttlingBurstLimit' => <integer>, 'throttlingRateLimit' => <float>, 'unauthorizedCacheControlHeaderStrategy' => 'FAIL_WITH_403|SUCCEED_WITH_RESPONSE_HEADER|SUCCEED_WITHOUT_RESPONSE_HEADER', ], // ... ], 'stageName' => '<string>', 'tags' => ['<string>', ...], 'tracingEnabled' => true || false, 'variables' => ['<string>', ...], 'webAclArn' => '<string>', ]
Result Details
Members
- accessLogSettings
-
- Type: AccessLogSettings structure
Settings for logging access in this stage.
- cacheClusterEnabled
-
- Type: boolean
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
totrue
for a method. - cacheClusterSize
-
- Type: string
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
- cacheClusterStatus
-
- Type: string
The status of the cache cluster for the stage, if enabled.
- canarySettings
-
- Type: CanarySettings structure
Settings for the canary deployment in this stage.
- clientCertificateId
-
- Type: string
The identifier of a client certificate for an API stage.
- createdDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the stage was created.
- deploymentId
-
- Type: string
The identifier of the Deployment that the stage points to.
- description
-
- Type: string
The stage's description.
- documentationVersion
-
- Type: string
The version of the associated API documentation.
- lastUpdatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the stage last updated.
- methodSettings
-
- Type: Associative array of custom strings keys (String) to MethodSetting structures
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. - stageName
-
- Type: string
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.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- tracingEnabled
-
- Type: boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
- variables
-
- Type: Associative array of custom strings keys (String) to strings
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-._~:/?#&=,]+
. - webAclArn
-
- Type: string
The ARN of the WebAcl associated with the Stage.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateUsage
$result = $client->updateUsage
([/* ... */]); $promise = $client->updateUsageAsync
([/* ... */]);
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
Parameter Syntax
$result = $client->updateUsage([ 'keyId' => '<string>', // REQUIRED 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'usagePlanId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- keyId
-
- Required: Yes
- Type: string
The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- usagePlanId
-
- Required: Yes
- Type: string
The Id of the usage plan associated with the usage data.
Result Syntax
[ 'endDate' => '<string>', 'items' => [ '<String>' => [ [<integer>, ...], // ... ], // ... ], 'position' => '<string>', 'startDate' => '<string>', 'usagePlanId' => '<string>', ]
Result Details
Members
- endDate
-
- Type: string
The ending date of the usage data.
- items
-
- Type: Associative array of custom strings keys (String) to lists
The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example,
{..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}
, where{api_key}
stands for an API key value and the daily log entry is of the format[used quota, remaining quota]
. - position
-
- Type: string
- startDate
-
- Type: string
The starting date of the usage data.
- usagePlanId
-
- Type: string
The plan Id associated with this usage data.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateUsagePlan
$result = $client->updateUsagePlan
([/* ... */]); $promise = $client->updateUsagePlanAsync
([/* ... */]);
Updates a usage plan of a given plan Id.
Parameter Syntax
$result = $client->updateUsagePlan([ 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'usagePlanId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- usagePlanId
-
- Required: Yes
- Type: string
The Id of the to-be-updated usage plan.
Result Syntax
[ 'apiStages' => [ [ 'apiId' => '<string>', 'stage' => '<string>', 'throttle' => [ '<String>' => [ 'burstLimit' => <integer>, 'rateLimit' => <float>, ], // ... ], ], // ... ], 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'productCode' => '<string>', 'quota' => [ 'limit' => <integer>, 'offset' => <integer>, 'period' => 'DAY|WEEK|MONTH', ], 'tags' => ['<string>', ...], 'throttle' => [ 'burstLimit' => <integer>, 'rateLimit' => <float>, ], ]
Result Details
Members
- apiStages
-
- Type: Array of ApiStage structures
The associated API stages of a usage plan.
- description
-
- Type: string
The description of a usage plan.
- id
-
- Type: string
The identifier of a UsagePlan resource.
- name
-
- Type: string
The name of a usage plan.
- productCode
-
- Type: string
The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
- quota
-
- Type: QuotaSettings structure
The target maximum number of permitted requests per a given unit time interval.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- throttle
-
- Type: ThrottleSettings structure
A map containing method level throttling information for API stage in a usage plan.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
UpdateVpcLink
$result = $client->updateVpcLink
([/* ... */]); $promise = $client->updateVpcLinkAsync
([/* ... */]);
Updates an existing VpcLink of a specified identifier.
Parameter Syntax
$result = $client->updateVpcLink([ 'patchOperations' => [ [ 'from' => '<string>', 'op' => 'add|remove|replace|move|copy|test', 'path' => '<string>', 'value' => '<string>', ], // ... ], 'vpcLinkId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- patchOperations
-
- Type: Array of PatchOperation structures
For more information about supported patch operations, see Patch Operations.
- vpcLinkId
-
- Required: Yes
- Type: string
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
Result Syntax
[ 'description' => '<string>', 'id' => '<string>', 'name' => '<string>', 'status' => 'AVAILABLE|PENDING|DELETING|FAILED', 'statusMessage' => '<string>', 'tags' => ['<string>', ...], 'targetArns' => ['<string>', ...], ]
Result Details
Members
- description
-
- Type: string
The description of the VPC link.
- id
-
- Type: string
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
- name
-
- Type: string
The name used to label and identify the VPC link.
- status
-
- Type: string
The status of the VPC link. The valid values are
AVAILABLE
,PENDING
,DELETING
, orFAILED
. Deploying an API will wait if the status isPENDING
and will fail if the status isDELETING
. - statusMessage
-
- Type: string
A description about the VPC link status.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
The collection of tags. Each tag element is associated with a given resource.
- targetArns
-
- Type: Array of strings
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 Amazon Web Services account of the API owner.
Errors
- BadRequestException:
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
- ConflictException:
The request configuration has conflicts. For details, see the accompanying error message.
- LimitExceededException:
The request exceeded the rate limit. Retry after the specified time period.
- NotFoundException:
The requested resource is not found. Make sure that the request URI is correct.
- UnauthorizedException:
The request is denied because the caller has insufficient permissions.
- TooManyRequestsException:
The request has reached its throttling limit. Retry after the specified time period.
Shapes
AccessLogSettings
Description
Access log settings, including the access log format and access log destination ARN.
Members
- destinationArn
-
- Type: string
The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with
amazon-apigateway-
. - format
-
- Type: string
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least
$context.requestId
.
ApiStage
Description
API stage name of the associated API stage in a usage plan.
Members
- apiId
-
- Type: string
API Id of the associated API stage in a usage plan.
- stage
-
- Type: string
API stage name of the associated API stage in a usage plan.
- throttle
-
- Type: Associative array of custom strings keys (String) to ThrottleSettings structures
Map containing method level throttling information for API stage in a usage plan.
BadRequestException
Description
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
Members
- message
-
- Type: string
CanarySettings
Description
Configuration settings of a canary deployment.
Members
- deploymentId
-
- Type: string
The ID of the canary deployment.
- percentTraffic
-
- Type: double
The percent (0-100) of traffic diverted to a canary deployment.
- stageVariableOverrides
-
- Type: Associative array of custom strings keys (String) to strings
Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
- useStageCache
-
- Type: boolean
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
ConflictException
Description
The request configuration has conflicts. For details, see the accompanying error message.
Members
- message
-
- Type: string
DeploymentCanarySettings
Description
The input configuration for a canary deployment.
Members
- percentTraffic
-
- Type: double
The percentage (0.0-100.0) of traffic routed to the canary deployment.
- stageVariableOverrides
-
- Type: Associative array of custom strings keys (String) to strings
A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.
- useStageCache
-
- Type: boolean
A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
DocumentationPartLocation
Description
Specifies the target API entity to which the documentation applies.
Members
- method
-
- Type: string
The HTTP verb of a method. It is a valid field for the API entity types of
METHOD
,PATH_PARAMETER
,QUERY_PARAMETER
,REQUEST_HEADER
,REQUEST_BODY
,RESPONSE
,RESPONSE_HEADER
, andRESPONSE_BODY
. The default value is*
for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the otherlocation
attributes, the child entity'smethod
attribute must match that of the parent entity exactly. - name
-
- Type: string
The name of the targeted API entity. It is a valid and required field for the API entity types of
AUTHORIZER
,MODEL
,PATH_PARAMETER
,QUERY_PARAMETER
,REQUEST_HEADER
,REQUEST_BODY
andRESPONSE_HEADER
. It is an invalid field for any other entity type. - path
-
- Type: string
The URL path of the target. It is a valid field for the API entity types of
RESOURCE
,METHOD
,PATH_PARAMETER
,QUERY_PARAMETER
,REQUEST_HEADER
,REQUEST_BODY
,RESPONSE
,RESPONSE_HEADER
, andRESPONSE_BODY
. The default value is/
for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the otherlocation
attributes, the child entity'spath
attribute must match that of the parent entity as a prefix. - statusCode
-
- Type: string
The HTTP status code of a response. It is a valid field for the API entity types of
RESPONSE
,RESPONSE_HEADER
, andRESPONSE_BODY
. The default value is*
for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the otherlocation
attributes, the child entity'sstatusCode
attribute must match that of the parent entity exactly. - type
-
- Required: Yes
- Type: string
The type of API entity to which the documentation content applies. Valid values are
API
,AUTHORIZER
,MODEL
,RESOURCE
,METHOD
,PATH_PARAMETER
,QUERY_PARAMETER
,REQUEST_HEADER
,REQUEST_BODY
,RESPONSE
,RESPONSE_HEADER
, andRESPONSE_BODY
. Content inheritance does not apply to any entity of theAPI
,AUTHORIZER
,METHOD
,MODEL
,REQUEST_BODY
, orRESOURCE
type.
EndpointConfiguration
Description
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
Members
- types
-
- Type: Array of strings
A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is
"EDGE"
. For a regional API and its custom domain name, the endpoint type isREGIONAL
. For a private API, the endpoint type isPRIVATE
. - vpcEndpointIds
-
- Type: Array of strings
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for
PRIVATE
endpoint type.
LimitExceededException
Description
The request exceeded the rate limit. Retry after the specified time period.
Members
- message
-
- Type: string
- retryAfterSeconds
-
- Type: string
MethodSetting
Description
Specifies the method setting properties.
Members
- cacheDataEncrypted
-
- Type: boolean
Specifies whether the cached responses are encrypted.
- cacheTtlInSeconds
-
- Type: int
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
- cachingEnabled
-
- Type: boolean
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
- dataTraceEnabled
-
- Type: boolean
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
- loggingLevel
-
- Type: string
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are
OFF
,ERROR
, andINFO
. ChooseERROR
to write only error-level entries to CloudWatch Logs, or chooseINFO
to include allERROR
events as well as extra informational events. - metricsEnabled
-
- Type: boolean
Specifies whether Amazon CloudWatch metrics are enabled for this method.
- requireAuthorizationForCacheControl
-
- Type: boolean
Specifies whether authorization is required for a cache invalidation request.
- throttlingBurstLimit
-
- Type: int
Specifies the throttling burst limit.
- throttlingRateLimit
-
- Type: double
Specifies the throttling rate limit.
- unauthorizedCacheControlHeaderStrategy
-
- Type: string
Specifies how to handle unauthorized requests for cache invalidation.
MethodSnapshot
Description
Represents a summary of a Method resource, given a particular date and time.
Members
- apiKeyRequired
-
- Type: boolean
Specifies whether the method requires a valid ApiKey.
- authorizationType
-
- Type: string
The method's authorization type. Valid values are
NONE