String format
A single line format of the access logs of data, as specified by selected $context variables. The format must
include at least $context.requestId.
String destinationArn
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-.
String id
The identifier of the API Key.
String value
The value of the API Key.
String name
The name of the API Key.
String customerId
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
String description
The description of the API Key.
Boolean enabled
Specifies whether the API Key can be used by callers.
Date createdDate
The timestamp when the API Key was created.
Date lastUpdatedDate
The timestamp when the API Key was last updated.
List<E> stageKeys
A list of Stage resources that are associated with the ApiKey resource.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String id
The identifier for the authorizer resource.
String name
The name of the authorizer.
String type
The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token
submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and
COGNITO_USER_POOLS for using an Amazon Cognito user pool.
List<E> providerARNs
A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is
of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a
TOKEN or REQUEST authorizer, this is not defined.
String authType
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
String authorizerUri
Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST
authorizers, this must be a well-formed Lambda function URI, for example,
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations
. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where
{region} is the same as the region hosting the Lambda function, path indicates that the
remaining substring in the URI should be treated as the path to the resource, including the initial
/. For Lambda functions, this is usually of the form
/2015-03-31/functions/[FunctionARN]/invocations.
String authorizerCredentials
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.
String identitySource
The identity source for which authorization is requested. For a TOKEN or
COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression
for the custom header holding the authorization token submitted by the client. For example, if the token header
name is Auth, the header mapping expression is method.request.header.Auth. For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a
comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an
Auth header, a Name query string parameter are defined as identity sources, this value
is method.request.header.Auth, method.request.querystring.Name. These parameters will
be used to derive the authorization caching key and to perform runtime validation of the REQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only
when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401
Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping
expressions of the specified request parameters. When the authorization caching is not enabled, this property is
optional.
String identityValidationExpression
A validation expression for the incoming identity token. For TOKEN authorizers, this value is a
regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud
field of the incoming token from the client against the specified regular expression. It will invoke the
authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without
calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
Integer authorizerResultTtlInSeconds
The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
Double percentTraffic
The percent (0-100) of traffic diverted to a canary deployment.
String deploymentId
The ID of the canary deployment.
Map<K,V> stageVariableOverrides
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.
Boolean useStageCache
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
String clientCertificateId
The identifier of the client certificate.
String description
The description of the client certificate.
String pemEncodedCertificate
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
Date createdDate
The timestamp when the client certificate was created.
Date expirationDate
The timestamp when the client certificate will expire.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String name
The name of the ApiKey.
String description
The description of the ApiKey.
Boolean enabled
Specifies whether the ApiKey can be used by callers.
Boolean generateDistinctId
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.
String value
Specifies a value of the API key.
List<E> stageKeys
DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
String customerId
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
Map<K,V> tags
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.
String id
The identifier of the API Key.
String value
The value of the API Key.
String name
The name of the API Key.
String customerId
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
String description
The description of the API Key.
Boolean enabled
Specifies whether the API Key can be used by callers.
Date createdDate
The timestamp when the API Key was created.
Date lastUpdatedDate
The timestamp when the API Key was last updated.
List<E> stageKeys
A list of Stage resources that are associated with the ApiKey resource.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String restApiId
The string identifier of the associated RestApi.
String name
The name of the authorizer.
String type
The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token
submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and
COGNITO_USER_POOLS for using an Amazon Cognito user pool.
List<E> providerARNs
A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is
of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a
TOKEN or REQUEST authorizer, this is not defined.
String authType
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
String authorizerUri
Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST
authorizers, this must be a well-formed Lambda function URI, for example,
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations
. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where
{region} is the same as the region hosting the Lambda function, path indicates that the
remaining substring in the URI should be treated as the path to the resource, including the initial
/. For Lambda functions, this is usually of the form
/2015-03-31/functions/[FunctionARN]/invocations.
String authorizerCredentials
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.
String identitySource
The identity source for which authorization is requested. For a TOKEN or
COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression
for the custom header holding the authorization token submitted by the client. For example, if the token header
name is Auth, the header mapping expression is method.request.header.Auth. For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a
comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an
Auth header, a Name query string parameter are defined as identity sources, this value
is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to
derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by
verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is
true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response
without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the
specified request parameters. When the authorization caching is not enabled, this property is optional.
String identityValidationExpression
A validation expression for the incoming identity token. For TOKEN authorizers, this value is a
regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud
field of the incoming token from the client against the specified regular expression. It will invoke the
authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without
calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
Integer authorizerResultTtlInSeconds
The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
String id
The identifier for the authorizer resource.
String name
The name of the authorizer.
String type
The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token
submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and
COGNITO_USER_POOLS for using an Amazon Cognito user pool.
List<E> providerARNs
A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is
of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a
TOKEN or REQUEST authorizer, this is not defined.
String authType
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
String authorizerUri
Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST
authorizers, this must be a well-formed Lambda function URI, for example,
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations
. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where
{region} is the same as the region hosting the Lambda function, path indicates that the
remaining substring in the URI should be treated as the path to the resource, including the initial
/. For Lambda functions, this is usually of the form
/2015-03-31/functions/[FunctionARN]/invocations.
String authorizerCredentials
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.
String identitySource
The identity source for which authorization is requested. For a TOKEN or
COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression
for the custom header holding the authorization token submitted by the client. For example, if the token header
name is Auth, the header mapping expression is method.request.header.Auth. For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a
comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an
Auth header, a Name query string parameter are defined as identity sources, this value
is method.request.header.Auth, method.request.querystring.Name. These parameters will
be used to derive the authorization caching key and to perform runtime validation of the REQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only
when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401
Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping
expressions of the specified request parameters. When the authorization caching is not enabled, this property is
optional.
String identityValidationExpression
A validation expression for the incoming identity token. For TOKEN authorizers, this value is a
regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud
field of the incoming token from the client against the specified regular expression. It will invoke the
authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without
calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
Integer authorizerResultTtlInSeconds
The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
String domainName
The domain name of the BasePathMapping resource to create.
String basePath
The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.
String restApiId
The string identifier of the associated RestApi.
String stage
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.
String restApiId
The string identifier of the associated RestApi.
String stageName
The name of the Stage resource for the Deployment resource to create.
String stageDescription
The description of the Stage resource for the Deployment resource to create.
String description
The description for the Deployment resource to create.
Boolean cacheClusterEnabled
Enables a cache cluster for the Stage resource specified in the input.
String cacheClusterSize
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
Map<K,V> variables
A map that defines the stage variables for the Stage resource that is associated with the new deployment.
Variable names can have alphanumeric and underscore characters, and the values must match
[A-Za-z0-9-._~:/?#&=,]+.
DeploymentCanarySettings canarySettings
The input configuration for the canary deployment when the deployment is a canary release deployment.
Boolean tracingEnabled
Specifies whether active tracing with X-ray is enabled for the Stage.
String id
The identifier for the deployment resource.
String description
The description for the deployment resource.
Date createdDate
The date and time that the deployment resource was created.
Map<K,V> apiSummary
A summary of the RestApi at the date and time that the deployment resource was created.
String restApiId
The string identifier of the associated RestApi.
DocumentationPartLocation location
The location of the targeted API entity of the to-be-created documentation part.
String properties
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.
String id
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
DocumentationPartLocation location
The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
String properties
A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a
JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant
documentation-related fields from the properties map are exported and, hence, published as part of the API entity
definitions, while the original documentation parts are exported in a OpenAPI extension of
x-amazon-apigateway-documentation.
String restApiId
The string identifier of the associated RestApi.
String documentationVersion
The version identifier of the new snapshot.
String stageName
The stage name to be associated with the new documentation snapshot.
String description
A description about the new documentation snapshot.
String domainName
The name of the DomainName resource.
String certificateName
The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
String certificateBody
[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
String certificatePrivateKey
[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
String certificateChain
[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
String certificateArn
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
String regionalCertificateName
The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
String regionalCertificateArn
The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.
EndpointConfiguration endpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
Map<K,V> tags
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.
String securityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0 and TLS_1_2.
MutualTlsAuthenticationInput mutualTlsAuthentication
String ownershipVerificationCertificateArn
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.
String domainName
The custom domain name as an API host name, for example, my-api.example.com.
String certificateName
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
String certificateArn
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
Date certificateUploadDate
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
String regionalDomainName
The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
String regionalHostedZoneId
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
String regionalCertificateName
The name of the certificate that will be used for validating the regional domain name.
String regionalCertificateArn
The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
String distributionDomainName
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
String distributionHostedZoneId
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name
and AWS Regions and Endpoints for API Gateway.
EndpointConfiguration endpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
String domainNameStatus
The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If
the status is UPDATING, the domain cannot be modified further until the existing operation is
complete. If it is AVAILABLE, the domain can be updated.
String domainNameStatusMessage
An optional text message containing detailed information about status of the DomainName migration.
String securityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0 and TLS_1_2.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
MutualTlsAuthentication mutualTlsAuthentication
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.
String ownershipVerificationCertificateArn
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.
String restApiId
The RestApi identifier under which the Model will be created.
String name
The name of the model. Must be alphanumeric.
String description
The description of the model.
String schema
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
String contentType
The content-type for the model.
String id
The identifier for the model resource.
String name
The name of the model. Must be an alphanumeric string.
String description
The description of the model.
String schema
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.
String contentType
The content-type for the model.
String restApiId
The string identifier of the associated RestApi.
String name
The name of the to-be-created RequestValidator.
Boolean validateRequestBody
A Boolean flag to indicate whether to validate request body according to the configured model schema for the
method (true) or not (false).
Boolean validateRequestParameters
A Boolean flag to indicate whether to validate request parameters, true, or not false.
String id
The identifier of this RequestValidator.
String name
The name of this RequestValidator
Boolean validateRequestBody
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
Boolean validateRequestParameters
A Boolean flag to indicate whether to validate request parameters (true) or not (false
).
String id
The resource's identifier.
String parentId
The parent resource's identifier.
String pathPart
The last path segment for this resource.
String path
The full path for this resource.
Map<K,V> resourceMethods
Gets an API resource's method of a given HTTP verb.
String name
The name of the RestApi.
String description
The description of the RestApi.
String version
A version identifier for the API.
String cloneFrom
The ID of the RestApi that you want to clone from.
List<E> binaryMediaTypes
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Integer minimumCompressionSize
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.
String apiKeySource
The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
EndpointConfiguration endpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.
String policy
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Map<K,V> tags
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.
Boolean disableExecuteApiEndpoint
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
String id
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The timestamp when the API was created.
String version
A version identifier for the API.
List<E> warnings
The warning messages reported when failonwarnings is turned on during API import.
List<E> binaryMediaTypes
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Integer minimumCompressionSize
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.
String apiKeySource
The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
EndpointConfiguration endpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.
String policy
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Boolean disableExecuteApiEndpoint
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
String restApiId
The string identifier of the associated RestApi.
String stageName
The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
String deploymentId
The identifier of the Deployment resource for the Stage resource.
String description
The description of the Stage resource.
Boolean cacheClusterEnabled
Whether cache clustering is enabled for the stage.
String cacheClusterSize
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
Map<K,V> variables
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-._~:/?#&=,]+.
String documentationVersion
The version of the associated API documentation.
CanarySettings canarySettings
The canary deployment settings of this stage.
Boolean tracingEnabled
Specifies whether active tracing with X-ray is enabled for the Stage.
Map<K,V> tags
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.
String deploymentId
The identifier of the Deployment that the stage points to.
String clientCertificateId
The identifier of a client certificate for an API stage.
String stageName
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.
String description
The stage's description.
Boolean cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
String cacheClusterSize
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
String cacheClusterStatus
The status of the cache cluster for the stage, if enabled.
Map<K,V> methodSettings
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.
Map<K,V> variables
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-._~:/?#&=,]+.
String documentationVersion
The version of the associated API documentation.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
CanarySettings canarySettings
Settings for the canary deployment in this stage.
Boolean tracingEnabled
Specifies whether active tracing with X-ray is enabled for the Stage.
String webAclArn
The ARN of the WebAcl associated with the Stage.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Date createdDate
The timestamp when the stage was created.
Date lastUpdatedDate
The timestamp when the stage last updated.
String usagePlanId
The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.
String keyId
The identifier of a UsagePlanKey resource for a plan customer.
String keyType
The type of a UsagePlanKey resource for a plan customer.
String name
The name of the usage plan.
String description
The description of the usage plan.
List<E> apiStages
The associated API stages of the usage plan.
ThrottleSettings throttle
The throttling limits of the usage plan.
QuotaSettings quota
The quota of the usage plan.
Map<K,V> tags
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.
String id
The identifier of a UsagePlan resource.
String name
The name of a usage plan.
String description
The description of a usage plan.
List<E> apiStages
The associated API stages of a usage plan.
ThrottleSettings throttle
A map containing method level throttling information for API stage in a usage plan.
QuotaSettings quota
The target maximum number of permitted requests per a given unit time interval.
String productCode
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String name
The name used to label and identify the VPC link.
String description
The description of the VPC link.
List<E> targetArns
The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
Map<K,V> tags
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.
String id
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
String name
The name used to label and identify the VPC link.
String description
The description of the VPC link.
List<E> targetArns
The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
String status
The status of the VPC link. The valid values are AVAILABLE, PENDING,
DELETING, or FAILED. Deploying an API will wait if the status is PENDING
and will fail if the status is DELETING.
String statusMessage
A description about the VPC link status.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String apiKey
The identifier of the ApiKey resource to be deleted.
String clientCertificateId
The identifier of the ClientCertificate resource to be deleted.
String domainName
The name of the DomainName resource to be deleted.
String restApiId
The string identifier of the associated RestApi.
String resourceId
Specifies a delete integration response request's resource identifier.
String httpMethod
Specifies a delete integration response request's HTTP method.
String statusCode
Specifies a delete integration response request's status code.
String restApiId
The string identifier of the associated RestApi.
String resourceId
The Resource identifier for the MethodResponse resource.
String httpMethod
The HTTP verb of the Method resource.
String statusCode
The status code identifier for the MethodResponse resource.
String restApiId
The string identifier of the associated RestApi.
String usagePlanId
The Id of the to-be-deleted usage plan.
String vpcLinkId
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
String id
The identifier for the deployment resource.
String description
The description for the deployment resource.
Date createdDate
The date and time that the deployment resource was created.
Map<K,V> apiSummary
A summary of the RestApi at the date and time that the deployment resource was created.
Double percentTraffic
The percentage (0.0-100.0) of traffic routed to the canary deployment.
Map<K,V> stageVariableOverrides
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.
Boolean useStageCache
A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
String id
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
DocumentationPartLocation location
The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
String properties
A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a
JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant
documentation-related fields from the properties map are exported and, hence, published as part of the API entity
definitions, while the original documentation parts are exported in a OpenAPI extension of
x-amazon-apigateway-documentation.
String type
The type of API entity to which the documentation content applies. Valid values are API,
AUTHORIZER, MODEL, RESOURCE, METHOD,
PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does
not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type.
String path
The URL path of the target. It is a valid field for the API entity types of RESOURCE,
METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER,
REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY.
The default value is / for the root resource. When an applicable child entity inherits the content
of another entity of the same type with more general specifications of the other location
attributes, the child entity's path attribute must match that of the parent entity as a prefix.
String method
The HTTP verb of a method. It is a valid field for the API entity types of METHOD,
PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is
* for any method. When an applicable child entity inherits the content of an entity of the same type
with more general specifications of the other location attributes, the child entity's
method attribute must match that of the parent entity exactly.
String statusCode
The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE,
RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status
code. When an applicable child entity inherits the content of an entity of the same type with more general
specifications of the other location attributes, the child entity's statusCode
attribute must match that of the parent entity exactly.
String name
The name of the targeted API entity. It is a valid and required field for the API entity types of
AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER,
REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field
for any other entity type.
String domainName
The custom domain name as an API host name, for example, my-api.example.com.
String certificateName
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
String certificateArn
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
Date certificateUploadDate
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
String regionalDomainName
The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
String regionalHostedZoneId
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
String regionalCertificateName
The name of the certificate that will be used for validating the regional domain name.
String regionalCertificateArn
The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
String distributionDomainName
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
String distributionHostedZoneId
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name
and AWS Regions and Endpoints for API Gateway.
EndpointConfiguration endpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
String domainNameStatus
The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If
the status is UPDATING, the domain cannot be modified further until the existing operation is
complete. If it is AVAILABLE, the domain can be updated.
String domainNameStatusMessage
An optional text message containing detailed information about status of the DomainName migration.
String securityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0 and TLS_1_2.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
MutualTlsAuthentication mutualTlsAuthentication
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.
String ownershipVerificationCertificateArn
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.
List<E> types
A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API
and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain
name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.
List<E> vpcEndpointIds
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for
PRIVATE endpoint type.
String responseType
The response type of the associated GatewayResponse.
String statusCode
The HTTP status code for this GatewayResponse.
Map<K,V> responseParameters
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
Map<K,V> responseTemplates
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
Boolean defaultResponse
A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or
not (false). A default gateway response is one generated by API Gateway without any customization by
an API developer.
String clientCertificateId
The identifier of the client certificate.
String description
The description of the client certificate.
String pemEncodedCertificate
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
Date createdDate
The timestamp when the client certificate was created.
Date expirationDate
The timestamp when the client certificate will expire.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String cloudwatchRoleArn
The ARN of an Amazon CloudWatch role for the current Account.
ThrottleSettings throttleSettings
Specifies the API request limits configured for the current Account.
List<E> features
A list of features supported for the account. When usage plans are enabled, the features list will include an
entry of "UsagePlans".
String apiKeyVersion
The version of the API keys used for the account.
String id
The identifier of the API Key.
String value
The value of the API Key.
String name
The name of the API Key.
String customerId
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
String description
The description of the API Key.
Boolean enabled
Specifies whether the API Key can be used by callers.
Date createdDate
The timestamp when the API Key was created.
Date lastUpdatedDate
The timestamp when the API Key was last updated.
List<E> stageKeys
A list of Stage resources that are associated with the ApiKey resource.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String position
The current pagination position in the paged result set.
Integer limit
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
String nameQuery
The name of queried API keys.
String customerId
The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.
Boolean includeValues
A boolean flag to specify whether (true) or not (false) the result contains key values.
String id
The identifier for the authorizer resource.
String name
The name of the authorizer.
String type
The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token
submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and
COGNITO_USER_POOLS for using an Amazon Cognito user pool.
List<E> providerARNs
A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is
of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a
TOKEN or REQUEST authorizer, this is not defined.
String authType
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
String authorizerUri
Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST
authorizers, this must be a well-formed Lambda function URI, for example,
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations
. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where
{region} is the same as the region hosting the Lambda function, path indicates that the
remaining substring in the URI should be treated as the path to the resource, including the initial
/. For Lambda functions, this is usually of the form
/2015-03-31/functions/[FunctionARN]/invocations.
String authorizerCredentials
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.
String identitySource
The identity source for which authorization is requested. For a TOKEN or
COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression
for the custom header holding the authorization token submitted by the client. For example, if the token header
name is Auth, the header mapping expression is method.request.header.Auth. For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a
comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an
Auth header, a Name query string parameter are defined as identity sources, this value
is method.request.header.Auth, method.request.querystring.Name. These parameters will
be used to derive the authorization caching key and to perform runtime validation of the REQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only
when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401
Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping
expressions of the specified request parameters. When the authorization caching is not enabled, this property is
optional.
String identityValidationExpression
A validation expression for the incoming identity token. For TOKEN authorizers, this value is a
regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud
field of the incoming token from the client against the specified regular expression. It will invoke the
authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without
calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
Integer authorizerResultTtlInSeconds
The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
String domainName
The domain name of the BasePathMapping resource to be described.
String basePath
The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.
String clientCertificateId
The identifier of the ClientCertificate resource to be described.
String clientCertificateId
The identifier of the client certificate.
String description
The description of the client certificate.
String pemEncodedCertificate
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
Date createdDate
The timestamp when the client certificate was created.
Date expirationDate
The timestamp when the client certificate will expire.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String restApiId
The string identifier of the associated RestApi.
String deploymentId
The identifier of the Deployment resource to get information about.
List<E> embed
A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the
response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in
GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other
platform-dependent libraries might use a different format for the list. Currently, this request supports only
retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list
containing only the "apisummary" string. For example,
GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
String id
The identifier for the deployment resource.
String description
The description for the deployment resource.
Date createdDate
The date and time that the deployment resource was created.
Map<K,V> apiSummary
A summary of the RestApi at the date and time that the deployment resource was created.
String id
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
DocumentationPartLocation location
The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
String properties
A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a
JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant
documentation-related fields from the properties map are exported and, hence, published as part of the API entity
definitions, while the original documentation parts are exported in a OpenAPI extension of
x-amazon-apigateway-documentation.
String restApiId
The string identifier of the associated RestApi.
String type
The type of API entities of the to-be-retrieved documentation parts.
String nameQuery
The name of API entities of the to-be-retrieved documentation parts.
String path
The path of API entities of the to-be-retrieved documentation parts.
String position
The current pagination position in the paged result set.
Integer limit
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
String locationStatus
The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving
DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without
content.
String domainName
The name of the DomainName resource.
String domainName
The custom domain name as an API host name, for example, my-api.example.com.
String certificateName
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
String certificateArn
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
Date certificateUploadDate
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
String regionalDomainName
The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
String regionalHostedZoneId
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
String regionalCertificateName
The name of the certificate that will be used for validating the regional domain name.
String regionalCertificateArn
The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
String distributionDomainName
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
String distributionHostedZoneId
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name
and AWS Regions and Endpoints for API Gateway.
EndpointConfiguration endpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
String domainNameStatus
The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If
the status is UPDATING, the domain cannot be modified further until the existing operation is
complete. If it is AVAILABLE, the domain can be updated.
String domainNameStatusMessage
An optional text message containing detailed information about status of the DomainName migration.
String securityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0 and TLS_1_2.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
MutualTlsAuthentication mutualTlsAuthentication
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.
String ownershipVerificationCertificateArn
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.
String restApiId
The string identifier of the associated RestApi.
String stageName
The name of the Stage that will be exported.
String exportType
The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
Map<K,V> parameters
A key-value map of query string parameters that specify properties of the export, depending on the requested
exportType. For exportType oas30 and swagger, any combination
of the following parameters are supported: extensions='integrations' or
extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions.
extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions.
postman will export the API with Postman extensions, allowing for import to the Postman tool
String accepts
The content-type of the export, for example application/json. Currently
application/json and application/yaml are supported for exportType of
oas30 and swagger. This should be specified in the Accept header for
direct API requests.
String contentType
The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.
String contentDisposition
The content-disposition header value in the HTTP response.
ByteBuffer body
The binary blob response to GetExport, which contains the export.
String responseType
The response type of the associated GatewayResponse.
String statusCode
The HTTP status code for this GatewayResponse.
Map<K,V> responseParameters
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
Map<K,V> responseTemplates
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
Boolean defaultResponse
A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or
not (false). A default gateway response is one generated by API Gateway without any customization by
an API developer.
String restApiId
The string identifier of the associated RestApi.
String position
The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
Integer limit
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.
String restApiId
The string identifier of the associated RestApi.
String resourceId
Specifies a get integration response request's resource identifier.
String httpMethod
Specifies a get integration response request's HTTP method.
String statusCode
Specifies a get integration response request's status code.
String statusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse.
String selectionPattern
Specifies the regular expression (regex) pattern used to choose an integration response based on the response
from the back end. For example, if the success response returns nothing and the error response returns some
string, you could use the .+ regex to match error response. However, make sure that the error
response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda
function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status
code is matched.
Map<K,V> responseParameters
A key-value map specifying response parameters that are passed to the method response from the back end. The key
is a method response header parameter name and the mapped value is an integration response header value, a static
value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The
mapping key must match the pattern of method.response.header.{name}, where name is a
valid and unique header name. The mapped non-static value must match the pattern of
integration.response.header.{name} or integration.response.body.{JSON-expression},
where name is a valid and unique response header name and JSON-expression is a valid
JSON expression without the $ prefix.
Map<K,V> responseTemplates
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.
String contentHandling
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
String type
Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port
and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy
integration with a connectionType of VPC_LINK is referred to as a private integration
and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
String httpMethod
Specifies the integration's HTTP method type.
String uri
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S)
URL according to the RFC-3986 specification, for either standard integration, where connectionType
is not VPC_LINK, or private integration, where connectionType is VPC_LINK.
For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY
integrations, the URI is of the form
arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is
the API Gateway region (e.g., us-east-1); {service} is the name of the integrated 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 AWS 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 either
arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or
arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
String connectionType
The type of the network connection to the integration endpoint. The valid value is INTERNET for
connections through the public routable internet or VPC_LINK for private connections between API
Gateway and a network load balancer in a VPC. The default value is INTERNET.
String connectionId
The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
otherwise.
String credentials
Specifies the credentials required for the integration, if any. For AWS integrations, three options are
available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To
require that the caller's identity be passed through from the request, specify the string
arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
Map<K,V> requestParameters
A key-value map specifying request parameters that are passed from the method request to the back end. The key is
an integration request parameter name and the associated value is a method request parameter value or static
value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request
parameter value must match the pattern of method.request.{location}.{name}, where
location is querystring, path, or header and
name must be a valid and unique method request parameter name.
Map<K,V> requestTemplates
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.
String passthroughBehavior
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.
String contentHandling
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the request payload will be passed through from the method request to
integration request without modification, provided that the passthroughBehavior is configured to
support payload pass-through.
Integer timeoutInMillis
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
String cacheNamespace
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace. You can specify the same cacheNamespace across resources to return the
same cached data for requests to different resources.
List<E> cacheKeyParameters
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters, these parameters must also be specified for Method
requestParameters.
Map<K,V> integrationResponses
Specifies the integration's responses.
TlsConfig tlsConfig
Specifies the TLS configuration for an integration.
String restApiId
The string identifier of the associated RestApi.
String resourceId
The Resource identifier for the MethodResponse resource.
String httpMethod
The HTTP verb of the Method resource.
String statusCode
The status code for the MethodResponse resource.
String statusCode
The method response's status code.
Map<K,V> responseParameters
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
A key defines a method response header and the value specifies whether the associated method response header is
required or not. The expression of the key must match the pattern method.response.header.{name},
where name is a valid and unique header name. API Gateway passes certain integration response data
to the method response headers specified here according to the mapping you prescribe in the API's
IntegrationResponse. The integration response data that can be mapped include an integration response header
expressed in integration.response.header.{name}, a static value enclosed within a pair of single
quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the
form of integration.response.body.{JSON-expression}, where JSON-expression is a valid
JSON expression without the $ prefix.)
Map<K,V> responseModels
Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
String httpMethod
The method's HTTP verb.
String authorizationType
The method's authorization type. Valid values are NONE for open access, AWS_IAM for
using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS
for using a Cognito user pool.
String authorizerId
The identifier of an Authorizer to use on this method. The authorizationType must be
CUSTOM.
Boolean apiKeyRequired
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
String requestValidatorId
The identifier of a RequestValidator for request validation.
String operationName
A human-friendly operation identifier for the method. For example, you can assign the operationName
of ListPets for the GET /pets method in the PetStore example.
Map<K,V> requestParameters
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A
key is a method request parameter name matching the pattern of method.request.{location}.{name},
where location is querystring, path, or header and
name is a valid and unique parameter name. The value associated with the key is a Boolean flag
indicating whether the parameter is required (true) or optional (false). The method
request parameter names defined here are available in Integration to be mapped to integration request parameters
or templates.
Map<K,V> requestModels
A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
Map<K,V> methodResponses
Gets a method response associated with a given HTTP status code.
Integration methodIntegration
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.
List<E> authorizationScopes
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.
String restApiId
The RestApi identifier under which the Model exists.
String modelName
The name of the model as an identifier.
Boolean flatten
A query parameter of a Boolean value to resolve (true) all external model references and returns a
flattened model schema or not (false) The default is false.
String id
The identifier for the model resource.
String name
The name of the model. Must be an alphanumeric string.
String description
The description of the model.
String schema
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.
String contentType
The content-type for the model.
String value
The Apache Velocity Template Language (VTL) template content used for the template resource.
String id
The identifier of this RequestValidator.
String name
The name of this RequestValidator
Boolean validateRequestBody
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
Boolean validateRequestParameters
A Boolean flag to indicate whether to validate request parameters (true) or not (false
).
String restApiId
The string identifier of the associated RestApi.
String resourceId
The identifier for the Resource resource.
List<E> embed
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.
String id
The resource's identifier.
String parentId
The parent resource's identifier.
String pathPart
The last path segment for this resource.
String path
The full path for this resource.
Map<K,V> resourceMethods
Gets an API resource's method of a given HTTP verb.
String restApiId
The string identifier of the associated RestApi.
String position
The current pagination position in the paged result set.
Integer limit
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
List<E> embed
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.
String restApiId
The string identifier of the associated RestApi.
String id
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The timestamp when the API was created.
String version
A version identifier for the API.
List<E> warnings
The warning messages reported when failonwarnings is turned on during API import.
List<E> binaryMediaTypes
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Integer minimumCompressionSize
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.
String apiKeySource
The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
EndpointConfiguration endpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.
String policy
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Boolean disableExecuteApiEndpoint
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
String restApiId
The string identifier of the associated RestApi.
String stageName
The name of the Stage that the SDK will use.
String sdkType
The language for the generated SDK. Currently java, javascript, android,
objectivec (for iOS), swift (for iOS), and ruby are supported.
Map<K,V> parameters
A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For
sdkType of objectivec or swift, a parameter named classPrefix
is required. For sdkType of android, parameters named groupId,
artifactId, artifactVersion, and invokerPackage are required. For
sdkType of java, parameters named serviceName and
javaPackageName are required.
String contentType
The content-type header value in the HTTP response.
String contentDisposition
The content-disposition header value in the HTTP response.
ByteBuffer body
The binary blob response to GetSdk, which contains the generated SDK.
String id
The identifier of the queried SdkType instance.
String deploymentId
The identifier of the Deployment that the stage points to.
String clientCertificateId
The identifier of a client certificate for an API stage.
String stageName
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.
String description
The stage's description.
Boolean cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
String cacheClusterSize
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
String cacheClusterStatus
The status of the cache cluster for the stage, if enabled.
Map<K,V> methodSettings
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.
Map<K,V> variables
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-._~:/?#&=,]+.
String documentationVersion
The version of the associated API documentation.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
CanarySettings canarySettings
Settings for the canary deployment in this stage.
Boolean tracingEnabled
Specifies whether active tracing with X-ray is enabled for the Stage.
String webAclArn
The ARN of the WebAcl associated with the Stage.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Date createdDate
The timestamp when the stage was created.
Date lastUpdatedDate
The timestamp when the stage last updated.
String resourceArn
The ARN of a resource that can be tagged.
String position
(Not currently supported) The current pagination position in the paged result set.
Integer limit
(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
String usagePlanId
The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
String position
The current pagination position in the paged result set.
Integer limit
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
String nameQuery
A query parameter specifying the name of the to-be-returned usage plan keys.
String usagePlanId
The identifier of the UsagePlan resource to be retrieved.
String id
The identifier of a UsagePlan resource.
String name
The name of a usage plan.
String description
The description of a usage plan.
List<E> apiStages
The associated API stages of a usage plan.
ThrottleSettings throttle
A map containing method level throttling information for API stage in a usage plan.
QuotaSettings quota
The target maximum number of permitted requests per a given unit time interval.
String productCode
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String usagePlanId
The Id of the usage plan associated with the usage data.
String keyId
The Id of the API key associated with the resultant usage data.
String startDate
The starting date (e.g., 2016-01-01) of the usage data.
String endDate
The ending date (e.g., 2016-12-31) of the usage data.
String position
The current pagination position in the paged result set.
Integer limit
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
String usagePlanId
The plan Id associated with this usage data.
String startDate
The starting date of the usage data.
String endDate
The ending date of the usage data.
String position
Map<K,V> items
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].
String vpcLinkId
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
String id
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
String name
The name used to label and identify the VPC link.
String description
The description of the VPC link.
List<E> targetArns
The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
String status
The status of the VPC link. The valid values are AVAILABLE, PENDING,
DELETING, or FAILED. Deploying an API will wait if the status is PENDING
and will fail if the status is DELETING.
String statusMessage
A description about the VPC link status.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
ByteBuffer body
The payload of the POST request to import API keys. For the payload format, see API Key File Format.
String format
A query parameter to specify the input format to imported API keys. Currently, only the csv format
is supported.
Boolean failOnWarnings
A query parameter to indicate whether to rollback ApiKey importation (true) or not (
false) when error is encountered.
String restApiId
The string identifier of the associated RestApi.
String mode
A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts
definition or to merge (MERGE) the new definition into the existing one. The default value is
MERGE.
Boolean failOnWarnings
A query parameter to specify whether to rollback the documentation importation (true) or not (
false) when a warning is encountered. The default value is false.
ByteBuffer body
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
Boolean failOnWarnings
A query parameter to indicate whether to rollback the API creation (true) or not (false
) when a warning is encountered. The default value is false.
Map<K,V> parameters
A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.
To exclude DocumentationParts from the import, set parameters as ignore=documentation.
To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE,
endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default
endpoint type is EDGE.
To handle imported basepath, set parameters as basepath=ignore,
basepath=prepend or basepath=split.
For example, the AWS CLI command to exclude documentation from the imported API is:
The AWS CLI command to set the regional endpoint on the imported API is:
ByteBuffer body
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.
String id
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The timestamp when the API was created.
String version
A version identifier for the API.
List<E> warnings
The warning messages reported when failonwarnings is turned on during API import.
List<E> binaryMediaTypes
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Integer minimumCompressionSize
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.
String apiKeySource
The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
EndpointConfiguration endpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.
String policy
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Boolean disableExecuteApiEndpoint
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
String type
Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port
and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy
integration with a connectionType of VPC_LINK is referred to as a private integration
and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
String httpMethod
Specifies the integration's HTTP method type.
String uri
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S)
URL according to the RFC-3986 specification, for either standard integration, where connectionType
is not VPC_LINK, or private integration, where connectionType is VPC_LINK.
For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY
integrations, the URI is of the form
arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is
the API Gateway region (e.g., us-east-1); {service} is the name of the integrated 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 AWS 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 either
arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or
arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
String connectionType
The type of the network connection to the integration endpoint. The valid value is INTERNET for
connections through the public routable internet or VPC_LINK for private connections between API
Gateway and a network load balancer in a VPC. The default value is INTERNET.
String connectionId
The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
otherwise.
String credentials
Specifies the credentials required for the integration, if any. For AWS integrations, three options are
available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To
require that the caller's identity be passed through from the request, specify the string
arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
Map<K,V> requestParameters
A key-value map specifying request parameters that are passed from the method request to the back end. The key is
an integration request parameter name and the associated value is a method request parameter value or static
value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request
parameter value must match the pattern of method.request.{location}.{name}, where
location is querystring, path, or header and
name must be a valid and unique method request parameter name.
Map<K,V> requestTemplates
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.
String passthroughBehavior
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.
String contentHandling
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the request payload will be passed through from the method request to
integration request without modification, provided that the passthroughBehavior is configured to
support payload pass-through.
Integer timeoutInMillis
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
String cacheNamespace
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace. You can specify the same cacheNamespace across resources to return the
same cached data for requests to different resources.
List<E> cacheKeyParameters
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters, these parameters must also be specified for Method
requestParameters.
Map<K,V> integrationResponses
Specifies the integration's responses.
TlsConfig tlsConfig
Specifies the TLS configuration for an integration.
String statusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse.
String selectionPattern
Specifies the regular expression (regex) pattern used to choose an integration response based on the response
from the back end. For example, if the success response returns nothing and the error response returns some
string, you could use the .+ regex to match error response. However, make sure that the error
response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda
function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status
code is matched.
Map<K,V> responseParameters
A key-value map specifying response parameters that are passed to the method response from the back end. The key
is a method response header parameter name and the mapped value is an integration response header value, a static
value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The
mapping key must match the pattern of method.response.header.{name}, where name is a
valid and unique header name. The mapped non-static value must match the pattern of
integration.response.header.{name} or integration.response.body.{JSON-expression},
where name is a valid and unique response header name and JSON-expression is a valid
JSON expression without the $ prefix.
Map<K,V> responseTemplates
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.
String contentHandling
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
String retryAfterSeconds
String httpMethod
The method's HTTP verb.
String authorizationType
The method's authorization type. Valid values are NONE for open access, AWS_IAM for
using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS
for using a Cognito user pool.
String authorizerId
The identifier of an Authorizer to use on this method. The authorizationType must be
CUSTOM.
Boolean apiKeyRequired
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
String requestValidatorId
The identifier of a RequestValidator for request validation.
String operationName
A human-friendly operation identifier for the method. For example, you can assign the operationName
of ListPets for the GET /pets method in the PetStore example.
Map<K,V> requestParameters
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A
key is a method request parameter name matching the pattern of method.request.{location}.{name},
where location is querystring, path, or header and
name is a valid and unique parameter name. The value associated with the key is a Boolean flag
indicating whether the parameter is required (true) or optional (false). The method
request parameter names defined here are available in Integration to be mapped to integration request parameters
or templates.
Map<K,V> requestModels
A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
Map<K,V> methodResponses
Gets a method response associated with a given HTTP status code.
Integration methodIntegration
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.
List<E> authorizationScopes
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.
String statusCode
The method response's status code.
Map<K,V> responseParameters
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
A key defines a method response header and the value specifies whether the associated method response header is
required or not. The expression of the key must match the pattern method.response.header.{name},
where name is a valid and unique header name. API Gateway passes certain integration response data
to the method response headers specified here according to the mapping you prescribe in the API's
IntegrationResponse. The integration response data that can be mapped include an integration response header
expressed in integration.response.header.{name}, a static value enclosed within a pair of single
quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the
form of integration.response.body.{JSON-expression}, where JSON-expression is a valid
JSON expression without the $ prefix.)
Map<K,V> responseModels
Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
Boolean metricsEnabled
Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is
/{method_setting_key}/metrics/enabled, and the value is a Boolean.
String loggingLevel
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The
PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are
OFF, ERROR, and INFO. Choose ERROR to write only error-level
entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra
informational events.
Boolean dataTraceEnabled
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon
CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the
value is a Boolean.
Integer throttlingBurstLimit
Specifies the throttling burst limit. The PATCH path for this setting is
/{method_setting_key}/throttling/burstLimit, and the value is an integer.
Double throttlingRateLimit
Specifies the throttling rate limit. The PATCH path for this setting is
/{method_setting_key}/throttling/rateLimit, and the value is a double.
Boolean cachingEnabled
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the
stage for responses to be cached. The PATCH path for this setting is
/{method_setting_key}/caching/enabled, and the value is a Boolean.
Integer cacheTtlInSeconds
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response
will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and
the value is an integer.
Boolean cacheDataEncrypted
Specifies whether the cached responses are encrypted. The PATCH path for this setting is
/{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.
Boolean requireAuthorizationForCacheControl
Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is
/{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.
String unauthorizedCacheControlHeaderStrategy
Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is
/{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are
FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER,
SUCCEED_WITHOUT_RESPONSE_HEADER.
String authorizationType
The method's authorization type. Valid values are NONE for open access, AWS_IAM for
using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS
for using a Cognito user pool.
Boolean apiKeyRequired
Specifies whether the method requires a valid ApiKey.
String id
The identifier for the model resource.
String name
The name of the model. Must be an alphanumeric string.
String description
The description of the model.
String schema
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.
String contentType
The content-type for the model.
String truststoreUri
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example
s3://bucket-name/key-name. The truststore can contain certificates from public or private
certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain
name to use the new version. To update the truststore, you must have permissions to access the S3 object.
String truststoreVersion
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
List<E> truststoreWarnings
A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.
String truststoreUri
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example
s3://bucket-name/key-name. The truststore can contain certificates from public or private
certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain
name to use the new version. To update the truststore, you must have permissions to access the S3 object.
String truststoreVersion
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket
String op
An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message..
String path
The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.
String value
The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'.
String from
The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId".
String restApiId
The string identifier of the associated RestApi.
String responseType
The response type of the associated GatewayResponse
String statusCode
The HTTP status code of the GatewayResponse.
Map<K,V> responseParameters
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
Map<K,V> responseTemplates
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
String responseType
The response type of the associated GatewayResponse.
String statusCode
The HTTP status code for this GatewayResponse.
Map<K,V> responseParameters
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
Map<K,V> responseTemplates
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
Boolean defaultResponse
A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or
not (false). A default gateway response is one generated by API Gateway without any customization by
an API developer.
String restApiId
The string identifier of the associated RestApi.
String resourceId
Specifies a put integration request's resource ID.
String httpMethod
Specifies the HTTP method for the integration.
String type
Specifies a put integration input's type.
String integrationHttpMethod
The HTTP method for the integration.
String uri
Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for
either standard integration, where connectionType is not VPC_LINK, or private
integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI
is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form
arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api . Here, {Region} is
the API Gateway region (e.g., us-east-1); {service} is the name of the integrated 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 either
arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or
arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.
String connectionType
The type of the network connection to the integration endpoint. The valid value is INTERNET for
connections through the public routable internet or VPC_LINK for private connections between API
Gateway and a network load balancer in a VPC. The default value is INTERNET.
String connectionId
The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as
the connection type.
String credentials
Specifies whether credentials are required for a put integration.
Map<K,V> requestParameters
A key-value map specifying request parameters that are passed from the method request to the back end. The key is
an integration request parameter name and the associated value is a method request parameter value or static
value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request
parameter value must match the pattern of method.request.{location}.{name}, where
location is querystring, path, or header and
name must be a valid and unique method request parameter name.
Map<K,V> requestTemplates
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.
String passthroughBehavior
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and
the available mapping templates specified as the requestTemplates property on the Integration
resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
NEVER.
String cacheNamespace
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace. You can specify the same cacheNamespace across resources to return the
same cached data for requests to different resources.
List<E> cacheKeyParameters
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters, these parameters must also be specified for Method
requestParameters.
String contentHandling
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the request payload will be passed through from the method request to
integration request without modification, provided that the passthroughBehavior is configured to
support payload pass-through.
Integer timeoutInMillis
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
TlsConfig tlsConfig
String restApiId
The string identifier of the associated RestApi.
String resourceId
Specifies a put integration response request's resource identifier.
String httpMethod
Specifies a put integration response request's HTTP method.
String statusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse.
String selectionPattern
Specifies the selection pattern of a put integration response.
Map<K,V> responseParameters
A key-value map specifying response parameters that are passed to the method response from the back end. The key
is a method response header parameter name and the mapped value is an integration response header value, a static
value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The
mapping key must match the pattern of method.response.header.{name}, where name is a
valid and unique header name. The mapped non-static value must match the pattern of
integration.response.header.{name} or integration.response.body.{JSON-expression},
where name must be a valid and unique response header name and JSON-expression a valid
JSON expression without the $ prefix.
Map<K,V> responseTemplates
Specifies a put integration response's templates.
String contentHandling
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
String statusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse.
String selectionPattern
Specifies the regular expression (regex) pattern used to choose an integration response based on the response
from the back end. For example, if the success response returns nothing and the error response returns some
string, you could use the .+ regex to match error response. However, make sure that the error
response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda
function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status
code is matched.
Map<K,V> responseParameters
A key-value map specifying response parameters that are passed to the method response from the back end. The key
is a method response header parameter name and the mapped value is an integration response header value, a static
value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The
mapping key must match the pattern of method.response.header.{name}, where name is a
valid and unique header name. The mapped non-static value must match the pattern of
integration.response.header.{name} or integration.response.body.{JSON-expression},
where name is a valid and unique response header name and JSON-expression is a valid
JSON expression without the $ prefix.
Map<K,V> responseTemplates
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.
String contentHandling
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
String type
Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port
and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy
integration with a connectionType of VPC_LINK is referred to as a private integration
and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
String httpMethod
Specifies the integration's HTTP method type.
String uri
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S)
URL according to the RFC-3986 specification, for either standard integration, where connectionType
is not VPC_LINK, or private integration, where connectionType is VPC_LINK.
For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY
integrations, the URI is of the form
arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is
the API Gateway region (e.g., us-east-1); {service} is the name of the integrated 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 AWS 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 either
arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or
arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
String connectionType
The type of the network connection to the integration endpoint. The valid value is INTERNET for
connections through the public routable internet or VPC_LINK for private connections between API
Gateway and a network load balancer in a VPC. The default value is INTERNET.
String connectionId
The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
otherwise.
String credentials
Specifies the credentials required for the integration, if any. For AWS integrations, three options are
available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To
require that the caller's identity be passed through from the request, specify the string
arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
Map<K,V> requestParameters
A key-value map specifying request parameters that are passed from the method request to the back end. The key is
an integration request parameter name and the associated value is a method request parameter value or static
value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request
parameter value must match the pattern of method.request.{location}.{name}, where
location is querystring, path, or header and
name must be a valid and unique method request parameter name.
Map<K,V> requestTemplates
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.
String passthroughBehavior
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.
String contentHandling
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the request payload will be passed through from the method request to
integration request without modification, provided that the passthroughBehavior is configured to
support payload pass-through.
Integer timeoutInMillis
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
String cacheNamespace
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace. You can specify the same cacheNamespace across resources to return the
same cached data for requests to different resources.
List<E> cacheKeyParameters
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters, these parameters must also be specified for Method
requestParameters.
Map<K,V> integrationResponses
Specifies the integration's responses.
TlsConfig tlsConfig
Specifies the TLS configuration for an integration.
String restApiId
The string identifier of the associated RestApi.
String resourceId
The Resource identifier for the new Method resource.
String httpMethod
Specifies the method request's HTTP method type.
String authorizationType
The method's authorization type. Valid values are NONE for open access, AWS_IAM for
using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS
for using a Cognito user pool.
String authorizerId
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.
Boolean apiKeyRequired
Specifies whether the method required a valid ApiKey.
String operationName
A human-friendly operation identifier for the method. For example, you can assign the operationName
of ListPets for the GET /pets method in the PetStore example.
Map<K,V> requestParameters
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A
key defines a method request parameter name matching the pattern of method.request.{location}.{name}
, where location is querystring, path, or header and
name is a valid and unique parameter name. The value associated with the key is a Boolean flag
indicating whether the parameter is required (true) or optional (false). The method
request parameter names defined here are available in Integration to be mapped to integration request parameters
or body-mapping templates.
Map<K,V> requestModels
Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
String requestValidatorId
The identifier of a RequestValidator for validating the method request.
List<E> authorizationScopes
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.
String restApiId
The string identifier of the associated RestApi.
String resourceId
The Resource identifier for the Method resource.
String httpMethod
The HTTP verb of the Method resource.
String statusCode
The method response's status code.
Map<K,V> responseParameters
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
A key defines a method response header name and the associated value is a Boolean flag indicating whether the
method response parameter is required or not. The method response header names must match the pattern of
method.response.header.{name}, where name is a valid and unique header name. The
response parameter names defined here are available in the integration response to be mapped from an integration
response header expressed in integration.response.header.{name}, a static value enclosed within a
pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response
payload in the form of integration.response.body.{JSON-expression}, where
JSON-expression is a valid JSON expression without the $ prefix.)
Map<K,V> responseModels
Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
String statusCode
The method response's status code.
Map<K,V> responseParameters
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
A key defines a method response header and the value specifies whether the associated method response header is
required or not. The expression of the key must match the pattern method.response.header.{name},
where name is a valid and unique header name. API Gateway passes certain integration response data
to the method response headers specified here according to the mapping you prescribe in the API's
IntegrationResponse. The integration response data that can be mapped include an integration response header
expressed in integration.response.header.{name}, a static value enclosed within a pair of single
quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the
form of integration.response.body.{JSON-expression}, where JSON-expression is a valid
JSON expression without the $ prefix.)
Map<K,V> responseModels
Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
String httpMethod
The method's HTTP verb.
String authorizationType
The method's authorization type. Valid values are NONE for open access, AWS_IAM for
using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS
for using a Cognito user pool.
String authorizerId
The identifier of an Authorizer to use on this method. The authorizationType must be
CUSTOM.
Boolean apiKeyRequired
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
String requestValidatorId
The identifier of a RequestValidator for request validation.
String operationName
A human-friendly operation identifier for the method. For example, you can assign the operationName
of ListPets for the GET /pets method in the PetStore example.
Map<K,V> requestParameters
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A
key is a method request parameter name matching the pattern of method.request.{location}.{name},
where location is querystring, path, or header and
name is a valid and unique parameter name. The value associated with the key is a Boolean flag
indicating whether the parameter is required (true) or optional (false). The method
request parameter names defined here are available in Integration to be mapped to integration request parameters
or templates.
Map<K,V> requestModels
A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
Map<K,V> methodResponses
Gets a method response associated with a given HTTP status code.
Integration methodIntegration
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.
List<E> authorizationScopes
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.
String restApiId
The string identifier of the associated RestApi.
String mode
The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By
default, the update mode is "merge".
Boolean failOnWarnings
A query parameter to indicate whether to rollback the API update (true) or not (false)
when a warning is encountered. The default value is false.
Map<K,V> parameters
Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API,
set ignore=documentation as a parameters value, as in the AWS CLI command of
aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
.
ByteBuffer body
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.
String id
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The timestamp when the API was created.
String version
A version identifier for the API.
List<E> warnings
The warning messages reported when failonwarnings is turned on during API import.
List<E> binaryMediaTypes
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Integer minimumCompressionSize
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.
String apiKeySource
The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
EndpointConfiguration endpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.
String policy
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Boolean disableExecuteApiEndpoint
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
Integer limit
The target maximum number of requests that can be made in a given time period.
Integer offset
The number of requests subtracted from the given limit in the initial time period.
String period
The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
String id
The identifier of this RequestValidator.
String name
The name of this RequestValidator
Boolean validateRequestBody
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
Boolean validateRequestParameters
A Boolean flag to indicate whether to validate request parameters (true) or not (false
).
String id
The resource's identifier.
String parentId
The parent resource's identifier.
String pathPart
The last path segment for this resource.
String path
The full path for this resource.
Map<K,V> resourceMethods
Gets an API resource's method of a given HTTP verb.
String id
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The timestamp when the API was created.
String version
A version identifier for the API.
List<E> warnings
The warning messages reported when failonwarnings is turned on during API import.
List<E> binaryMediaTypes
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Integer minimumCompressionSize
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.
String apiKeySource
The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
EndpointConfiguration endpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.
String policy
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Boolean disableExecuteApiEndpoint
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
String name
The name of a an SdkType configuration property.
String friendlyName
The user-friendly name of an SdkType configuration property.
String description
The description of an SdkType configuration property.
Boolean required
A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is
required (true) or not (false).
String defaultValue
The default value of an SdkType configuration property.
String retryAfterSeconds
String deploymentId
The identifier of the Deployment that the stage points to.
String clientCertificateId
The identifier of a client certificate for an API stage.
String stageName
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.
String description
The stage's description.
Boolean cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
String cacheClusterSize
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
String cacheClusterStatus
The status of the cache cluster for the stage, if enabled.
Map<K,V> methodSettings
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.
Map<K,V> variables
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-._~:/?#&=,]+.
String documentationVersion
The version of the associated API documentation.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
CanarySettings canarySettings
Settings for the canary deployment in this stage.
Boolean tracingEnabled
Specifies whether active tracing with X-ray is enabled for the Stage.
String webAclArn
The ARN of the WebAcl associated with the Stage.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Date createdDate
The timestamp when the stage was created.
Date lastUpdatedDate
The timestamp when the stage last updated.
String restApiId
The string identifier of the associated RestApi.
String authorizerId
Specifies a test invoke authorizer request's Authorizer ID.
Map<K,V> headers
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.
Map<K,V> multiValueHeaders
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.
String pathWithQueryString
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
String body
The simulated request body of an incoming invocation request.
Map<K,V> stageVariables
A key-value map of stage variables to simulate an invocation on a deployed Stage.
Map<K,V> additionalContext
A key-value map of additional context variables.
Integer clientStatus
The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
String log
The API Gateway execution log for the test authorizer request.
Long latency
The execution latency of the test authorizer request.
String principalId
The principal identity returned by the Authorizer
String policy
The JSON policy document returned by the Authorizer
Map<K,V> authorization
The authorization response.
Map<K,V> claims
The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
String restApiId
The string identifier of the associated RestApi.
String resourceId
Specifies a test invoke method request's resource ID.
String httpMethod
Specifies a test invoke method request's HTTP method.
String pathWithQueryString
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
String body
The simulated request body of an incoming invocation request.
Map<K,V> headers
A key-value map of headers to simulate an incoming invocation request.
Map<K,V> multiValueHeaders
The headers as a map from string to list of values to simulate an incoming invocation request.
String clientCertificateId
A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
Map<K,V> stageVariables
A key-value map of stage variables to simulate an invocation on a deployed Stage.
Integer status
The HTTP status code.
String body
The body of the HTTP response.
Map<K,V> headers
The headers of the HTTP response.
Map<K,V> multiValueHeaders
The headers of the HTTP response as a map from string to list of values.
String log
The API Gateway execution log for the test invoke request.
Long latency
The execution latency of the test invoke request.
Boolean insecureSkipVerification
Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is
issued by a supported certificate authority. This isn’t recommended, but it enables you to use certificates that
are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway
still performs basic certificate validation, which includes checking the certificate's expiration date, hostname,
and presence of a root certificate authority. Supported only for HTTP and HTTP_PROXY
integrations.
Enabling insecureSkipVerification isn't recommended, especially for integrations with public HTTPS
endpoints. If you enable insecureSkipVerification, you increase the risk of man-in-the-middle
attacks.
String retryAfterSeconds
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String cloudwatchRoleArn
The ARN of an Amazon CloudWatch role for the current Account.
ThrottleSettings throttleSettings
Specifies the API request limits configured for the current Account.
List<E> features
A list of features supported for the account. When usage plans are enabled, the features list will include an
entry of "UsagePlans".
String apiKeyVersion
The version of the API keys used for the account.
String apiKey
The identifier of the ApiKey resource to be updated.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String id
The identifier of the API Key.
String value
The value of the API Key.
String name
The name of the API Key.
String customerId
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
String description
The description of the API Key.
Boolean enabled
Specifies whether the API Key can be used by callers.
Date createdDate
The timestamp when the API Key was created.
Date lastUpdatedDate
The timestamp when the API Key was last updated.
List<E> stageKeys
A list of Stage resources that are associated with the ApiKey resource.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String restApiId
The string identifier of the associated RestApi.
String authorizerId
The identifier of the Authorizer resource.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String id
The identifier for the authorizer resource.
String name
The name of the authorizer.
String type
The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token
submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and
COGNITO_USER_POOLS for using an Amazon Cognito user pool.
List<E> providerARNs
A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is
of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a
TOKEN or REQUEST authorizer, this is not defined.
String authType
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
String authorizerUri
Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST
authorizers, this must be a well-formed Lambda function URI, for example,
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations
. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where
{region} is the same as the region hosting the Lambda function, path indicates that the
remaining substring in the URI should be treated as the path to the resource, including the initial
/. For Lambda functions, this is usually of the form
/2015-03-31/functions/[FunctionARN]/invocations.
String authorizerCredentials
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.
String identitySource
The identity source for which authorization is requested. For a TOKEN or
COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression
for the custom header holding the authorization token submitted by the client. For example, if the token header
name is Auth, the header mapping expression is method.request.header.Auth. For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a
comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an
Auth header, a Name query string parameter are defined as identity sources, this value
is method.request.header.Auth, method.request.querystring.Name. These parameters will
be used to derive the authorization caching key and to perform runtime validation of the REQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only
when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401
Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping
expressions of the specified request parameters. When the authorization caching is not enabled, this property is
optional.
String identityValidationExpression
A validation expression for the incoming identity token. For TOKEN authorizers, this value is a
regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud
field of the incoming token from the client against the specified regular expression. It will invoke the
authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without
calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
Integer authorizerResultTtlInSeconds
The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
String domainName
The domain name of the BasePathMapping resource to change.
String basePath
The base path of the BasePathMapping resource to change.
To specify an empty base path, set this parameter to '(none)'.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String clientCertificateId
The identifier of the ClientCertificate resource to be updated.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String clientCertificateId
The identifier of the client certificate.
String description
The description of the client certificate.
String pemEncodedCertificate
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
Date createdDate
The timestamp when the client certificate was created.
Date expirationDate
The timestamp when the client certificate will expire.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String restApiId
The string identifier of the associated RestApi.
String deploymentId
The replacement identifier for the Deployment resource to change information about.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String id
The identifier for the deployment resource.
String description
The description for the deployment resource.
Date createdDate
The date and time that the deployment resource was created.
Map<K,V> apiSummary
A summary of the RestApi at the date and time that the deployment resource was created.
String restApiId
The string identifier of the associated RestApi.
String documentationPartId
The identifier of the to-be-updated documentation part.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String id
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
DocumentationPartLocation location
The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
String properties
A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a
JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant
documentation-related fields from the properties map are exported and, hence, published as part of the API entity
definitions, while the original documentation parts are exported in a OpenAPI extension of
x-amazon-apigateway-documentation.
String restApiId
The string identifier of the associated RestApi..
String documentationVersion
The version identifier of the to-be-updated documentation version.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String domainName
The name of the DomainName resource to be changed.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String domainName
The custom domain name as an API host name, for example, my-api.example.com.
String certificateName
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
String certificateArn
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
Date certificateUploadDate
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
String regionalDomainName
The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
String regionalHostedZoneId
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
String regionalCertificateName
The name of the certificate that will be used for validating the regional domain name.
String regionalCertificateArn
The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
String distributionDomainName
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
String distributionHostedZoneId
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name
and AWS Regions and Endpoints for API Gateway.
EndpointConfiguration endpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
String domainNameStatus
The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If
the status is UPDATING, the domain cannot be modified further until the existing operation is
complete. If it is AVAILABLE, the domain can be updated.
String domainNameStatusMessage
An optional text message containing detailed information about status of the DomainName migration.
String securityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0 and TLS_1_2.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
MutualTlsAuthentication mutualTlsAuthentication
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.
String ownershipVerificationCertificateArn
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.
String restApiId
The string identifier of the associated RestApi.
String responseType
The response type of the associated GatewayResponse.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String responseType
The response type of the associated GatewayResponse.
String statusCode
The HTTP status code for this GatewayResponse.
Map<K,V> responseParameters
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
Map<K,V> responseTemplates
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
Boolean defaultResponse
A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or
not (false). A default gateway response is one generated by API Gateway without any customization by
an API developer.
String restApiId
The string identifier of the associated RestApi.
String resourceId
Represents an update integration request's resource identifier.
String httpMethod
Represents an update integration request's HTTP method.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String restApiId
The string identifier of the associated RestApi.
String resourceId
Specifies an update integration response request's resource identifier.
String httpMethod
Specifies an update integration response request's HTTP method.
String statusCode
Specifies an update integration response request's status code.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String statusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse.
String selectionPattern
Specifies the regular expression (regex) pattern used to choose an integration response based on the response
from the back end. For example, if the success response returns nothing and the error response returns some
string, you could use the .+ regex to match error response. However, make sure that the error
response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda
function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status
code is matched.
Map<K,V> responseParameters
A key-value map specifying response parameters that are passed to the method response from the back end. The key
is a method response header parameter name and the mapped value is an integration response header value, a static
value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The
mapping key must match the pattern of method.response.header.{name}, where name is a
valid and unique header name. The mapped non-static value must match the pattern of
integration.response.header.{name} or integration.response.body.{JSON-expression},
where name is a valid and unique response header name and JSON-expression is a valid
JSON expression without the $ prefix.
Map<K,V> responseTemplates
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.
String contentHandling
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
String type
Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port
and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy
integration with a connectionType of VPC_LINK is referred to as a private integration
and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
String httpMethod
Specifies the integration's HTTP method type.
String uri
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S)
URL according to the RFC-3986 specification, for either standard integration, where connectionType
is not VPC_LINK, or private integration, where connectionType is VPC_LINK.
For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY
integrations, the URI is of the form
arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is
the API Gateway region (e.g., us-east-1); {service} is the name of the integrated 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 AWS 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 either
arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or
arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
String connectionType
The type of the network connection to the integration endpoint. The valid value is INTERNET for
connections through the public routable internet or VPC_LINK for private connections between API
Gateway and a network load balancer in a VPC. The default value is INTERNET.
String connectionId
The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
otherwise.
String credentials
Specifies the credentials required for the integration, if any. For AWS integrations, three options are
available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To
require that the caller's identity be passed through from the request, specify the string
arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
Map<K,V> requestParameters
A key-value map specifying request parameters that are passed from the method request to the back end. The key is
an integration request parameter name and the associated value is a method request parameter value or static
value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request
parameter value must match the pattern of method.request.{location}.{name}, where
location is querystring, path, or header and
name must be a valid and unique method request parameter name.
Map<K,V> requestTemplates
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.
String passthroughBehavior
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.
String contentHandling
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
If this property is not defined, the request payload will be passed through from the method request to
integration request without modification, provided that the passthroughBehavior is configured to
support payload pass-through.
Integer timeoutInMillis
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
String cacheNamespace
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace. You can specify the same cacheNamespace across resources to return the
same cached data for requests to different resources.
List<E> cacheKeyParameters
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters, these parameters must also be specified for Method
requestParameters.
Map<K,V> integrationResponses
Specifies the integration's responses.
TlsConfig tlsConfig
Specifies the TLS configuration for an integration.
String restApiId
The string identifier of the associated RestApi.
String resourceId
The Resource identifier for the Method resource.
String httpMethod
The HTTP verb of the Method resource.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String restApiId
The string identifier of the associated RestApi.
String resourceId
The Resource identifier for the MethodResponse resource.
String httpMethod
The HTTP verb of the Method resource.
String statusCode
The status code for the MethodResponse resource.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String statusCode
The method response's status code.
Map<K,V> responseParameters
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
A key defines a method response header and the value specifies whether the associated method response header is
required or not. The expression of the key must match the pattern method.response.header.{name},
where name is a valid and unique header name. API Gateway passes certain integration response data
to the method response headers specified here according to the mapping you prescribe in the API's
IntegrationResponse. The integration response data that can be mapped include an integration response header
expressed in integration.response.header.{name}, a static value enclosed within a pair of single
quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the
form of integration.response.body.{JSON-expression}, where JSON-expression is a valid
JSON expression without the $ prefix.)
Map<K,V> responseModels
Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
String httpMethod
The method's HTTP verb.
String authorizationType
The method's authorization type. Valid values are NONE for open access, AWS_IAM for
using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS
for using a Cognito user pool.
String authorizerId
The identifier of an Authorizer to use on this method. The authorizationType must be
CUSTOM.
Boolean apiKeyRequired
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
String requestValidatorId
The identifier of a RequestValidator for request validation.
String operationName
A human-friendly operation identifier for the method. For example, you can assign the operationName
of ListPets for the GET /pets method in the PetStore example.
Map<K,V> requestParameters
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A
key is a method request parameter name matching the pattern of method.request.{location}.{name},
where location is querystring, path, or header and
name is a valid and unique parameter name. The value associated with the key is a Boolean flag
indicating whether the parameter is required (true) or optional (false). The method
request parameter names defined here are available in Integration to be mapped to integration request parameters
or templates.
Map<K,V> requestModels
A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
Map<K,V> methodResponses
Gets a method response associated with a given HTTP status code.
Integration methodIntegration
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.
List<E> authorizationScopes
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.
String restApiId
The string identifier of the associated RestApi.
String modelName
The name of the model to update.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String id
The identifier for the model resource.
String name
The name of the model. Must be an alphanumeric string.
String description
The description of the model.
String schema
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.
String contentType
The content-type for the model.
String restApiId
The string identifier of the associated RestApi.
String requestValidatorId
The identifier of RequestValidator to be updated.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String id
The identifier of this RequestValidator.
String name
The name of this RequestValidator
Boolean validateRequestBody
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
Boolean validateRequestParameters
A Boolean flag to indicate whether to validate request parameters (true) or not (false
).
String restApiId
The string identifier of the associated RestApi.
String resourceId
The identifier of the Resource resource.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String id
The resource's identifier.
String parentId
The parent resource's identifier.
String pathPart
The last path segment for this resource.
String path
The full path for this resource.
Map<K,V> resourceMethods
Gets an API resource's method of a given HTTP verb.
String restApiId
The string identifier of the associated RestApi.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String id
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The timestamp when the API was created.
String version
A version identifier for the API.
List<E> warnings
The warning messages reported when failonwarnings is turned on during API import.
List<E> binaryMediaTypes
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Integer minimumCompressionSize
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.
String apiKeySource
The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
EndpointConfiguration endpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.
String policy
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Boolean disableExecuteApiEndpoint
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
String restApiId
The string identifier of the associated RestApi.
String stageName
The name of the Stage resource to change information about.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String deploymentId
The identifier of the Deployment that the stage points to.
String clientCertificateId
The identifier of a client certificate for an API stage.
String stageName
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.
String description
The stage's description.
Boolean cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
String cacheClusterSize
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
String cacheClusterStatus
The status of the cache cluster for the stage, if enabled.
Map<K,V> methodSettings
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.
Map<K,V> variables
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-._~:/?#&=,]+.
String documentationVersion
The version of the associated API documentation.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
CanarySettings canarySettings
Settings for the canary deployment in this stage.
Boolean tracingEnabled
Specifies whether active tracing with X-ray is enabled for the Stage.
String webAclArn
The ARN of the WebAcl associated with the Stage.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Date createdDate
The timestamp when the stage was created.
Date lastUpdatedDate
The timestamp when the stage last updated.
String usagePlanId
The Id of the to-be-updated usage plan.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String id
The identifier of a UsagePlan resource.
String name
The name of a usage plan.
String description
The description of a usage plan.
List<E> apiStages
The associated API stages of a usage plan.
ThrottleSettings throttle
A map containing method level throttling information for API stage in a usage plan.
QuotaSettings quota
The target maximum number of permitted requests per a given unit time interval.
String productCode
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String usagePlanId
The Id of the usage plan associated with the usage data.
String keyId
The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String usagePlanId
The plan Id associated with this usage data.
String startDate
The starting date of the usage data.
String endDate
The ending date of the usage data.
String position
Map<K,V> items
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].
String vpcLinkId
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
List<E> patchOperations
For more information about supported patch operations, see Patch Operations.
String id
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
String name
The name used to label and identify the VPC link.
String description
The description of the VPC link.
List<E> targetArns
The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
String status
The status of the VPC link. The valid values are AVAILABLE, PENDING,
DELETING, or FAILED. Deploying an API will wait if the status is PENDING
and will fail if the status is DELETING.
String statusMessage
A description about the VPC link status.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String id
The identifier of a UsagePlan resource.
String name
The name of a usage plan.
String description
The description of a usage plan.
List<E> apiStages
The associated API stages of a usage plan.
ThrottleSettings throttle
A map containing method level throttling information for API stage in a usage plan.
QuotaSettings quota
The target maximum number of permitted requests per a given unit time interval.
String productCode
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String id
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
String name
The name used to label and identify the VPC link.
String description
The description of the VPC link.
List<E> targetArns
The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
String status
The status of the VPC link. The valid values are AVAILABLE, PENDING,
DELETING, or FAILED. Deploying an API will wait if the status is PENDING
and will fail if the status is DELETING.
String statusMessage
A description about the VPC link status.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Copyright © 2023. All rights reserved.