String id
The identifier of the API Key.
String name
The name of the API Key.
String description
The description of the API Key.
Boolean enabled
Specifies whether the API Key can be used by callers.
List<E> stageKeys
Date createdDate
The date when the API Key was created, in ISO 8601 format.
Date lastUpdatedDate
When the API Key was last updated, in ISO 8601 format.
String id
The identifier for the authorizer resource.
String name
[Required] The name of the authorizer.
String type
[Required] The type of the authorizer. Currently, the only valid type is TOKEN.
String authType
Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
String authorizerUri
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
For TOKEN authorizers, this must be a well-formed Lambda function URI.
The URI should be of the form
arn:aws:apigateway:{region}:lambda:path/{service_api}
.
Region
is used to determine the right endpoint. In this
case, path
is used to indicate 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 credentials required for the authorizer, if any. Two options are available. To specify an IAM Role for Amazon 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
[Required] The source of the identity in an incoming request. For TOKEN authorizers, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token.
String identityValidationExpression
A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
Integer authorizerResultTtlInSeconds
The TTL in seconds of cached authorizer results. If 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 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, that can be used to configure certificate authentication in the integration endpoint .
Date createdDate
The date when the Client Certificate was created, in ISO 8601 format.
Date expirationDate
The date when the Client Certificate will expire, in ISO 8601 format.
String id
The identifier of the API Key.
String name
The name of the API Key.
String description
The description of the API Key.
Boolean enabled
Specifies whether the API Key can be used by callers.
List<E> stageKeys
Date createdDate
The date when the API Key was created, in ISO 8601 format.
Date lastUpdatedDate
When the API Key was last updated, in ISO 8601 format.
String restApiId
The RestApi identifier under which the Authorizer will be created.
String name
[Required] The name of the authorizer.
String type
[Required] The type of the authorizer.
String authType
Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
String authorizerUri
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
String authorizerCredentials
Specifies the credentials required for the authorizer, if any.
String identitySource
[Required] The source of the identity in an incoming request.
String identityValidationExpression
A validation expression for the incoming identity.
Integer authorizerResultTtlInSeconds
The TTL of cached authorizer results.
String id
The identifier for the authorizer resource.
String name
[Required] The name of the authorizer.
String type
[Required] The type of the authorizer. Currently, the only valid type is TOKEN.
String authType
Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
String authorizerUri
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
For TOKEN authorizers, this must be a well-formed Lambda function URI.
The URI should be of the form
arn:aws:apigateway:{region}:lambda:path/{service_api}
.
Region
is used to determine the right endpoint. In this
case, path
is used to indicate 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 credentials required for the authorizer, if any. Two options are available. To specify an IAM Role for Amazon 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
[Required] The source of the identity in an incoming request. For TOKEN authorizers, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token.
String identityValidationExpression
A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
Integer authorizerResultTtlInSeconds
The TTL in seconds of cached authorizer results. If 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. Leave this blank if you do not want callers to specify a base path name after the domain name.
String restApiId
The name of the API that you want to apply this mapping to.
String stage
The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.
String restApiId
The RestApi resource identifier for the Deployment resource to create.
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
Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
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 characters, and the values must match
[A-Za-z0-9-._~:/?#&=,]+
.
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
Gets a summary of the RestApi at the date and time that the deployment resource was created.
String domainName
The name of the DomainName resource.
String certificateName
The name of the certificate.
String certificateBody
The body of the server certificate provided by your certificate authority.
String certificatePrivateKey
Your certificate's private key.
String certificateChain
The intermediate certificates and optionally the root certificate, one after the other without any blank lines. 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 domainName
The name of the DomainName resource.
String certificateName
The name of the certificate.
Date certificateUploadDate
The date when the certificate was uploaded, in ISO 8601 format.
String distributionDomainName
The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
String restApiId
String name
The name of the model.
String description
The description of the model.
String schema
The schema for the model. For application/json
models, this
should be JSON-schema draft v4 model.
String contentType
The content-type for the model.
String id
The identifier for the model resource.
String name
The name of the model.
String description
The description of the model.
String schema
The schema for the model. For application/json
models, this
should be JSON-schema draft v4 model.
String contentType
The content-type for the model.
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
Map of methods for this resource, which is included only if the request uses the embed query option.
String id
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The date when the API was created, in ISO 8601 format.
List<E> warnings
String restApiId
String stageName
The name for the Stage resource.
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 cluster size.
Map<K,V> variables
A map that defines the stage variables for the new Stage resource.
Variable names can have alphanumeric characters, and the values must
match [A-Za-z0-9-._~:/?#&=,]+
.
String deploymentId
The identifier of the Deployment that the stage points to.
String clientCertificateId
String stageName
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
String description
The stage's description.
Boolean cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
String cacheClusterSize
The size of the cache cluster for the stage, if enabled.
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
are defined as {resource_path}/{http_method}
for an
individual method override, or \*/\*
for the settings
applied to 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 characters, and the values must
match [A-Za-z0-9-._~:/?#&=,]+
.
Date createdDate
The date and time that the stage was created, in ISO 8601 format.
Date lastUpdatedDate
The date and time that information about the stage was last updated, in ISO 8601 format.
String restApiId
The RestApi identifier for the Authorizer resource.
String authorizerId
The identifier of the Authorizer resource.
String domainName
The domain name of the BasePathMapping resource to delete.
String basePath
The base path name of the BasePathMapping resource to delete.
String clientCertificateId
The identifier of the ClientCertificate resource to be deleted.
String restApiId
The identifier of the RestApi resource for the Deployment resource to delete.
String deploymentId
The identifier of the Deployment resource to delete.
String domainName
The name of the DomainName resource to be deleted.
String restApiId
Specifies a delete integration response request's API identifier.
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 RestApi identifier for the MethodResponse resource.
String resourceId
The Resource identifier for the MethodResponse resource.
String httpMethod
The HTTP verb identifier for the parent Method resource.
String statusCode
The status code identifier for the MethodResponse resource.
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
Gets a summary of the RestApi at the date and time that the deployment resource was created.
String domainName
The name of the DomainName resource.
String certificateName
The name of the certificate.
Date certificateUploadDate
The date when the certificate was uploaded, in ISO 8601 format.
String distributionDomainName
The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
String description
The description of the ClientCertificate.
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, that can be used to configure certificate authentication in the integration endpoint .
Date createdDate
The date when the Client Certificate was created, in ISO 8601 format.
Date expirationDate
The date when the Client Certificate will expire, in ISO 8601 format.
String cloudwatchRoleArn
Specifies the Amazon resource name (ARN) of an Amazon CloudWatch role for the current Account resource.
ThrottleSettings throttleSettings
Specifies the application programming interface (API) throttle settings for the current Account resource.
String id
The identifier of the API Key.
String name
The name of the API Key.
String description
The description of the API Key.
Boolean enabled
Specifies whether the API Key can be used by callers.
List<E> stageKeys
Date createdDate
The date when the API Key was created, in ISO 8601 format.
Date lastUpdatedDate
When the API Key was last updated, in ISO 8601 format.
String restApiId
The RestApi identifier for the Authorizer resource.
String authorizerId
The identifier of the Authorizer resource.
String id
The identifier for the authorizer resource.
String name
[Required] The name of the authorizer.
String type
[Required] The type of the authorizer. Currently, the only valid type is TOKEN.
String authType
Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
String authorizerUri
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
For TOKEN authorizers, this must be a well-formed Lambda function URI.
The URI should be of the form
arn:aws:apigateway:{region}:lambda:path/{service_api}
.
Region
is used to determine the right endpoint. In this
case, path
is used to indicate 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 credentials required for the authorizer, if any. Two options are available. To specify an IAM Role for Amazon 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
[Required] The source of the identity in an incoming request. For TOKEN authorizers, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token.
String identityValidationExpression
A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
Integer authorizerResultTtlInSeconds
The TTL in seconds of cached authorizer results. If 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 restApiId
The RestApi identifier for the Authorizers resource.
String position
If not all Authorizer resources in the response were present, the position will specificy where to start the next page of results.
Integer limit
Limit the number of Authorizer resources in the response.
String position
List<E> items
Gets the current list of Authorizer resources in the collection.
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. Leave this blank if you do not want callers to specify any base path name after the domain name.
String domainName
The domain name of a BasePathMapping resource.
String position
The position of the current BasePathMapping resource in the collection to get information about.
Integer limit
The maximum number of BasePathMapping resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
String position
List<E> items
The current page of any BasePathMapping resources in the collection of base path mapping resources.
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, that can be used to configure certificate authentication in the integration endpoint .
Date createdDate
The date when the Client Certificate was created, in ISO 8601 format.
Date expirationDate
The date when the Client Certificate will expire, in ISO 8601 format.
String position
The position of the current ClientCertificate resource in the collection to get information about.
Integer limit
The maximum number of ClientCertificate resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
String position
List<E> items
The current page of any ClientCertificate resources in the collection of ClientCertificate resources.
String restApiId
The identifier of the RestApi resource for the Deployment resource to get information about.
String deploymentId
The identifier of the Deployment resource to get information about.
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
Gets a summary of the RestApi at the date and time that the deployment resource was created.
String restApiId
The identifier of the RestApi resource for the collection of Deployment resources to get information about.
String position
The position of the current Deployment resource in the collection to get information about.
Integer limit
The maximum number of Deployment resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
String position
List<E> items
The current page of any Deployment resources in the collection of deployment resources.
String domainName
The name of the DomainName resource.
String domainName
The name of the DomainName resource.
String certificateName
The name of the certificate.
Date certificateUploadDate
The date when the certificate was uploaded, in ISO 8601 format.
String distributionDomainName
The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
String position
The position of the current domain names to get information about.
Integer limit
The maximum number of DomainName resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
String position
List<E> items
The current page of any DomainName resources in the collection of DomainName resources.
String restApiId
The identifier of the RestApi to be exported.
String stageName
The name of the Stage that will be exported.
String exportType
The type of export. Currently only 'swagger' is supported.
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 'swagger', any combination of the following parameters are supported: 'integrations' will export x-amazon-apigateway-integration extensions 'authorizers' will export x-amazon-apigateway-authorizer extensions 'postman' will export 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 'swagger'. Should be specifed 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 reseponse.
ByteBuffer body
The binary blob response to GetExport, which contains the export.
String restApiId
Specifies a get integration response request's API identifier.
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 backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.
Map<K,V> responseParameters
Represents response parameters that can be read from the backend
response. Response parameters are represented as a key/value map, with a
destination as the key and a source as the value. A destination must
match an existing response parameter in the MethodResponse. The
source can be a header from the backend response, or a static value.
Static values are specified using enclosing single quotes, and backend
response headers can be read using the pattern
integration.response.header.{name}
.
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 type
Specifies the integration's type. The valid value is HTTP
,
AWS
, or MOCK
.
String httpMethod
Specifies the integration's HTTP method type.
String uri
Specifies the integration's Uniform Resource Identifier (URI). For HTTP
integrations, the URI must be a fully formed, encoded HTTP(S) URL
according to the RFC-3986 specification. For AWS integrations, the URI
should be of the form
arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}
. Region
, subdomain
and service
are used to determine the right endpoint. For AWS services that use the
Action=
query string parameter, service_api
should be a valid action for the desired service. For RESTful AWS service
APIs, path
is used to indicate that the remaining substring
in the URI should be treated as the path to the resource, including the
initial /
.
String credentials
Specifies the credentials required for the integration, if any. For AWS
integrations, three options are available. To specify an IAM Role for
Amazon 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
Represents requests parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a destination
as the key and a source as the value. A source must match an existing
method request parameter, or a static value. Static values must be
enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
integration.request.{location}.{name}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.
Map<K,V> requestTemplates
Specifies the integration's request templates.
String cacheNamespace
Specifies the integration's cache namespace.
List<E> cacheKeyParameters
Specifies the integration's cache key parameters.
Map<K,V> integrationResponses
Specifies the integration's responses.
String restApiId
The RestApi identifier for the MethodResponse resource.
String resourceId
The Resource identifier for the MethodResponse resource.
String httpMethod
The HTTP verb identifier for the parent Method resource.
String statusCode
The status code identifier for the MethodResponse resource.
String statusCode
The method response's status code.
Map<K,V> responseParameters
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a boolean flag as the value, which
is used to specify whether the parameter is required. A destination must
match the pattern method.response.header.{name}
, where
name
is a valid, unique header name. Destinations specified
here are available to the integration for mapping from integration
response parameters.
Map<K,V> responseModels
String httpMethod
The HTTP method.
String authorizationType
The method's authorization type.
String authorizerId
Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.
Boolean apiKeyRequired
Specifies whether the method requires a valid ApiKey.
Map<K,V> requestParameters
Represents request parameters that can be accepted by Amazon API Gateway.
Request parameters are represented as a key/value map, with a source as
the key and a Boolean flag as the value. The Boolean flag is used to
specify whether the parameter is required. A source must match the
pattern method.request.{location}.{name}
, where
location
is either querystring, path, or header.
name
is a valid, unique parameter name. Sources specified
here are available to the integration for mapping to integration request
parameters or templates.
Map<K,V> requestModels
Map<K,V> methodResponses
Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.
Integration methodIntegration
The method's integration.
String id
The identifier for the model resource.
String name
The name of the model.
String description
The description of the model.
String schema
The schema for the model. For application/json
models, this
should be JSON-schema draft v4 model.
String contentType
The content-type for the model.
String restApiId
The RestApi identifier.
String position
The position of the next set of results in the Models resource to get information about.
Integer limit
The maximum number of models in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
String value
The Apache Velocity Template Language (VTL) template content used for the template resource.
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
Map of methods for this resource, which is included only if the request uses the embed query option.
String restApiId
The RestApi identifier for the Resource.
String position
The position of the next set of results in the current Resources resource to get information about.
Integer limit
The maximum number of Resource resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
String id
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The date when the API was created, in ISO 8601 format.
List<E> warnings
String restApiId
The identifier of the RestApi that the SDK will use.
String stageName
The name of the Stage that the SDK will use.
String sdkType
The language for the generated SDK. Currently javascript, android, and objectivec (for iOS) are supported.
Map<K,V> parameters
A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType. For sdkType 'objectivec', a parameter named "classPrefix" is required. For sdkType 'android', parameters named "groupId", "artifactId", "artifactVersion", and "invokerPackage" are required.
String contentType
The content-type header value in the HTTP response.
String contentDisposition
The content-disposition header value in the HTTP reseponse.
ByteBuffer body
The binary blob response to GetSdk, which contains the generated SDK.
String deploymentId
The identifier of the Deployment that the stage points to.
String clientCertificateId
String stageName
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
String description
The stage's description.
Boolean cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
String cacheClusterSize
The size of the cache cluster for the stage, if enabled.
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
are defined as {resource_path}/{http_method}
for an
individual method override, or \*/\*
for the settings
applied to 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 characters, and the values must
match [A-Za-z0-9-._~:/?#&=,]+
.
Date createdDate
The date and time that the stage was created, in ISO 8601 format.
Date lastUpdatedDate
The date and time that information about the stage was last updated, in ISO 8601 format.
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
Custom header parameters as part of the request.
ByteBuffer body
The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
String id
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The date when the API was created, in ISO 8601 format.
List<E> warnings
String type
Specifies the integration's type. The valid value is HTTP
,
AWS
, or MOCK
.
String httpMethod
Specifies the integration's HTTP method type.
String uri
Specifies the integration's Uniform Resource Identifier (URI). For HTTP
integrations, the URI must be a fully formed, encoded HTTP(S) URL
according to the RFC-3986 specification. For AWS integrations, the URI
should be of the form
arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}
. Region
, subdomain
and service
are used to determine the right endpoint. For AWS services that use the
Action=
query string parameter, service_api
should be a valid action for the desired service. For RESTful AWS service
APIs, path
is used to indicate that the remaining substring
in the URI should be treated as the path to the resource, including the
initial /
.
String credentials
Specifies the credentials required for the integration, if any. For AWS
integrations, three options are available. To specify an IAM Role for
Amazon 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
Represents requests parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a destination
as the key and a source as the value. A source must match an existing
method request parameter, or a static value. Static values must be
enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
integration.request.{location}.{name}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.
Map<K,V> requestTemplates
Specifies the integration's request templates.
String cacheNamespace
Specifies the integration's cache namespace.
List<E> cacheKeyParameters
Specifies the integration's cache key parameters.
Map<K,V> integrationResponses
Specifies the integration's responses.
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 backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.
Map<K,V> responseParameters
Represents response parameters that can be read from the backend
response. Response parameters are represented as a key/value map, with a
destination as the key and a source as the value. A destination must
match an existing response parameter in the MethodResponse. The
source can be a header from the backend response, or a static value.
Static values are specified using enclosing single quotes, and backend
response headers can be read using the pattern
integration.response.header.{name}
.
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 retryAfterSeconds
String httpMethod
The HTTP method.
String authorizationType
The method's authorization type.
String authorizerId
Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.
Boolean apiKeyRequired
Specifies whether the method requires a valid ApiKey.
Map<K,V> requestParameters
Represents request parameters that can be accepted by Amazon API Gateway.
Request parameters are represented as a key/value map, with a source as
the key and a Boolean flag as the value. The Boolean flag is used to
specify whether the parameter is required. A source must match the
pattern method.request.{location}.{name}
, where
location
is either querystring, path, or header.
name
is a valid, unique parameter name. Sources specified
here are available to the integration for mapping to integration request
parameters or templates.
Map<K,V> requestModels
Map<K,V> methodResponses
Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.
Integration methodIntegration
The method's integration.
String statusCode
The method response's status code.
Map<K,V> responseParameters
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a boolean flag as the value, which
is used to specify whether the parameter is required. A destination must
match the pattern method.response.header.{name}
, where
name
is a valid, unique header name. Destinations specified
here are available to the integration for mapping from integration
response parameters.
Map<K,V> responseModels
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 effects the log
entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting
is /{method_setting_key}/logging/loglevel
, and the available
levels are OFF
, ERROR
, and INFO
.
Boolean dataTraceEnabled
Specifies the whether data trace logging is enabled for this method,
which effects the log entries pushed to Amazon CloudWatch Logs. The PATCH
path for this setting is
/{method_setting_key}/logging/dataTrace
, and the value is a
Boolean.
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 a 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 the strategy on how to handle the 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 id
The identifier for the model resource.
String name
The name of the model.
String description
The description of the model.
String schema
The schema for the model. For application/json
models, this
should be JSON-schema draft v4 model.
String contentType
The content-type for the model.
String op
A patch operation whose value indicates the operation to perform. Its value MUST be one of "add", "remove", "replace", "move", "copy", or "test"; other values are errors.
String path
Operation objects MUST have exactly one "path" member. That member's value is a string containing a `JSON-Pointer` value that references a location within the target document (the "target location") where the operation is performed.
String value
The actual value content.
String from
The "move" and "copy" operation object MUST contain a "from" member,
which is a string containing a JSON Pointer
value that
references the location in the target document to move the value from.
String restApiId
Specifies a put integration request's API identifier.
String resourceId
Specifies a put integration request's resource ID.
String httpMethod
Specifies a put integration request's HTTP method.
String type
Specifies a put integration input's type.
String integrationHttpMethod
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
String uri
Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.
String credentials
Specifies whether credentials are required for a put integration.
Map<K,V> requestParameters
Represents request parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a destination
as the key and a source as the value. A source must match an existing
method request parameter, or a static value. Static values must be
enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
integration.request.{location}.{name}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.
Map<K,V> requestTemplates
Specifies the templates used to transform the method request body. Request templates are represented as a key/value map, with a content-type as the key and a template as the value.
String cacheNamespace
Specifies a put integration input's cache namespace.
List<E> cacheKeyParameters
Specifies a put integration input's cache key parameters.
String restApiId
Specifies a put integration response request's API identifier.
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
Represents response parameters that can be read from the backend
response. Response parameters are represented as a key/value map, with a
destination as the key and a source as the value. A destination must
match an existing response parameter in the Method. The source can
be a header from the backend response, or a static value. Static values
are specified using enclosing single quotes, and backend response headers
can be read using the pattern
integration.response.header.{name}
.
Map<K,V> responseTemplates
Specifies a put integration response's templates.
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 backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.
Map<K,V> responseParameters
Represents response parameters that can be read from the backend
response. Response parameters are represented as a key/value map, with a
destination as the key and a source as the value. A destination must
match an existing response parameter in the MethodResponse. The
source can be a header from the backend response, or a static value.
Static values are specified using enclosing single quotes, and backend
response headers can be read using the pattern
integration.response.header.{name}
.
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 type
Specifies the integration's type. The valid value is HTTP
,
AWS
, or MOCK
.
String httpMethod
Specifies the integration's HTTP method type.
String uri
Specifies the integration's Uniform Resource Identifier (URI). For HTTP
integrations, the URI must be a fully formed, encoded HTTP(S) URL
according to the RFC-3986 specification. For AWS integrations, the URI
should be of the form
arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}
. Region
, subdomain
and service
are used to determine the right endpoint. For AWS services that use the
Action=
query string parameter, service_api
should be a valid action for the desired service. For RESTful AWS service
APIs, path
is used to indicate that the remaining substring
in the URI should be treated as the path to the resource, including the
initial /
.
String credentials
Specifies the credentials required for the integration, if any. For AWS
integrations, three options are available. To specify an IAM Role for
Amazon 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
Represents requests parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a destination
as the key and a source as the value. A source must match an existing
method request parameter, or a static value. Static values must be
enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
integration.request.{location}.{name}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.
Map<K,V> requestTemplates
Specifies the integration's request templates.
String cacheNamespace
Specifies the integration's cache namespace.
List<E> cacheKeyParameters
Specifies the integration's cache key parameters.
Map<K,V> integrationResponses
Specifies the integration's responses.
String restApiId
String resourceId
String httpMethod
Specifies the put method request's HTTP method type.
String authorizationType
Specifies the type of authorization used for the method.
String authorizerId
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
Boolean apiKeyRequired
Specifies whether the method required a valid ApiKey.
Map<K,V> requestParameters
Represents requests parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a destination
as the key and a source as the value. A source must match an existing
method request parameter, or a static value. Static values must be
enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
integration.request.{location}.{name}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.
Map<K,V> requestModels
String restApiId
String resourceId
String httpMethod
The HTTP verb that identifies the Method resource.
String statusCode
The method response's status code.
Map<K,V> responseParameters
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a Boolean flag as the value. The
Boolean flag is used to specify whether the parameter is required. A
destination must match the pattern
method.response.header.{name}
, where name
is a
valid, unique header name. Destinations specified here are available to
the integration for mapping from integration response parameters.
Map<K,V> responseModels
String statusCode
The method response's status code.
Map<K,V> responseParameters
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a boolean flag as the value, which
is used to specify whether the parameter is required. A destination must
match the pattern method.response.header.{name}
, where
name
is a valid, unique header name. Destinations specified
here are available to the integration for mapping from integration
response parameters.
Map<K,V> responseModels
String httpMethod
The HTTP method.
String authorizationType
The method's authorization type.
String authorizerId
Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.
Boolean apiKeyRequired
Specifies whether the method requires a valid ApiKey.
Map<K,V> requestParameters
Represents request parameters that can be accepted by Amazon API Gateway.
Request parameters are represented as a key/value map, with a source as
the key and a Boolean flag as the value. The Boolean flag is used to
specify whether the parameter is required. A source must match the
pattern method.request.{location}.{name}
, where
location
is either querystring, path, or header.
name
is a valid, unique parameter name. Sources specified
here are available to the integration for mapping to integration request
parameters or templates.
Map<K,V> requestModels
Map<K,V> methodResponses
Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.
Integration methodIntegration
The method's integration.
String restApiId
The identifier of the RestApi to be updated.
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 headers supplied as part of the request.
ByteBuffer body
The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
String id
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The date when the API was created, in ISO 8601 format.
List<E> warnings
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
Map of methods for this resource, which is included only if the request uses the embed query option.
String id
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The date when the API was created, in ISO 8601 format.
List<E> warnings
String retryAfterSeconds
String deploymentId
The identifier of the Deployment that the stage points to.
String clientCertificateId
String stageName
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
String description
The stage's description.
Boolean cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
String cacheClusterSize
The size of the cache cluster for the stage, if enabled.
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
are defined as {resource_path}/{http_method}
for an
individual method override, or \*/\*
for the settings
applied to 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 characters, and the values must
match [A-Za-z0-9-._~:/?#&=,]+
.
Date createdDate
The date and time that the stage was created, in ISO 8601 format.
Date lastUpdatedDate
The date and time that information about the stage was last updated, in ISO 8601 format.
String restApiId
Specifies a test invoke authorizer request's RestApi identifier.
String authorizerId
Specifies a test invoke authorizer request's Authorizer ID.
Map<K,V> headers
[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
String pathWithQueryString
[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
String body
[Optional] 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
[Optional] 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 Amazon 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 policy JSON document returned by the Authorizer
Map<K,V> authorization
String restApiId
Specifies a test invoke method request's API identifier.
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.
String clientCertificateId
A ClientCertificate identifier to use in the test invocation. API Gateway will use use the certificate when making the HTTPS request to the defined backend endpoint.
Map<K,V> stageVariables
A key-value map of stage variables to simulate an invocation on a deployed Stage.
String retryAfterSeconds
String cloudwatchRoleArn
Specifies the Amazon resource name (ARN) of an Amazon CloudWatch role for the current Account resource.
ThrottleSettings throttleSettings
Specifies the application programming interface (API) throttle settings for the current Account resource.
String id
The identifier of the API Key.
String name
The name of the API Key.
String description
The description of the API Key.
Boolean enabled
Specifies whether the API Key can be used by callers.
List<E> stageKeys
Date createdDate
The date when the API Key was created, in ISO 8601 format.
Date lastUpdatedDate
When the API Key was last updated, in ISO 8601 format.
String restApiId
The RestApi identifier for the Authorizer resource.
String authorizerId
The identifier of the Authorizer resource.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String id
The identifier for the authorizer resource.
String name
[Required] The name of the authorizer.
String type
[Required] The type of the authorizer. Currently, the only valid type is TOKEN.
String authType
Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
String authorizerUri
[Required] Specifies the authorizer's Uniform Resource Identifier (URI).
For TOKEN authorizers, this must be a well-formed Lambda function URI.
The URI should be of the form
arn:aws:apigateway:{region}:lambda:path/{service_api}
.
Region
is used to determine the right endpoint. In this
case, path
is used to indicate 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 credentials required for the authorizer, if any. Two options are available. To specify an IAM Role for Amazon 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
[Required] The source of the identity in an incoming request. For TOKEN authorizers, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token.
String identityValidationExpression
A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
Integer authorizerResultTtlInSeconds
The TTL in seconds of cached authorizer results. If 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.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String clientCertificateId
The identifier of the ClientCertificate resource to be updated.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
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, that can be used to configure certificate authentication in the integration endpoint .
Date createdDate
The date when the Client Certificate was created, in ISO 8601 format.
Date expirationDate
The date when the Client Certificate will expire, in ISO 8601 format.
String restApiId
The replacement identifier of the RestApi resource for the Deployment resource to change information about.
String deploymentId
The replacment identifier for the Deployment resource to change information about.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
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
Gets a summary of the RestApi at the date and time that the deployment resource was created.
String domainName
The name of the DomainName resource to be changed.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String domainName
The name of the DomainName resource.
String certificateName
The name of the certificate.
Date certificateUploadDate
The date when the certificate was uploaded, in ISO 8601 format.
String distributionDomainName
The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
String restApiId
Represents an update integration request's API identifier.
String resourceId
Represents an update integration request's resource identifier.
String httpMethod
Represents an update integration request's HTTP method.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String restApiId
Specifies an update integration response request's API identifier.
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
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
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 backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.
Map<K,V> responseParameters
Represents response parameters that can be read from the backend
response. Response parameters are represented as a key/value map, with a
destination as the key and a source as the value. A destination must
match an existing response parameter in the MethodResponse. The
source can be a header from the backend response, or a static value.
Static values are specified using enclosing single quotes, and backend
response headers can be read using the pattern
integration.response.header.{name}
.
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 type
Specifies the integration's type. The valid value is HTTP
,
AWS
, or MOCK
.
String httpMethod
Specifies the integration's HTTP method type.
String uri
Specifies the integration's Uniform Resource Identifier (URI). For HTTP
integrations, the URI must be a fully formed, encoded HTTP(S) URL
according to the RFC-3986 specification. For AWS integrations, the URI
should be of the form
arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}
. Region
, subdomain
and service
are used to determine the right endpoint. For AWS services that use the
Action=
query string parameter, service_api
should be a valid action for the desired service. For RESTful AWS service
APIs, path
is used to indicate that the remaining substring
in the URI should be treated as the path to the resource, including the
initial /
.
String credentials
Specifies the credentials required for the integration, if any. For AWS
integrations, three options are available. To specify an IAM Role for
Amazon 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
Represents requests parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a destination
as the key and a source as the value. A source must match an existing
method request parameter, or a static value. Static values must be
enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
integration.request.{location}.{name}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.
Map<K,V> requestTemplates
Specifies the integration's request templates.
String cacheNamespace
Specifies the integration's cache namespace.
List<E> cacheKeyParameters
Specifies the integration's cache key parameters.
Map<K,V> integrationResponses
Specifies the integration's responses.
String restApiId
String resourceId
String httpMethod
The HTTP verb that identifies the Method resource.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String restApiId
The RestApi identifier for the MethodResponse resource.
String resourceId
The Resource identifier for the MethodResponse resource.
String httpMethod
The HTTP verb identifier for the parent Method resource.
String statusCode
The status code identifier for the MethodResponse resource.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String statusCode
The method response's status code.
Map<K,V> responseParameters
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a boolean flag as the value, which
is used to specify whether the parameter is required. A destination must
match the pattern method.response.header.{name}
, where
name
is a valid, unique header name. Destinations specified
here are available to the integration for mapping from integration
response parameters.
Map<K,V> responseModels
String httpMethod
The HTTP method.
String authorizationType
The method's authorization type.
String authorizerId
Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.
Boolean apiKeyRequired
Specifies whether the method requires a valid ApiKey.
Map<K,V> requestParameters
Represents request parameters that can be accepted by Amazon API Gateway.
Request parameters are represented as a key/value map, with a source as
the key and a Boolean flag as the value. The Boolean flag is used to
specify whether the parameter is required. A source must match the
pattern method.request.{location}.{name}
, where
location
is either querystring, path, or header.
name
is a valid, unique parameter name. Sources specified
here are available to the integration for mapping to integration request
parameters or templates.
Map<K,V> requestModels
Map<K,V> methodResponses
Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.
Integration methodIntegration
The method's integration.
String restApiId
The RestApi identifier under which the model exists.
String modelName
The name of the model to update.
List<E> patchOperations
A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
String id
The identifier for the model resource.
String name
The name of the model.
String description
The description of the model.
String schema
The schema for the model. For application/json
models, this
should be JSON-schema draft v4 model.
String contentType
The content-type for the model.
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
Map of methods for this resource, which is included only if the request uses the embed query option.
String id
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
String name
The API's name.
String description
The API's description.
Date createdDate
The date when the API was created, in ISO 8601 format.
List<E> warnings
String deploymentId
The identifier of the Deployment that the stage points to.
String clientCertificateId
String stageName
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
String description
The stage's description.
Boolean cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.
String cacheClusterSize
The size of the cache cluster for the stage, if enabled.
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
are defined as {resource_path}/{http_method}
for an
individual method override, or \*/\*
for the settings
applied to 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 characters, and the values must
match [A-Za-z0-9-._~:/?#&=,]+
.
Date createdDate
The date and time that the stage was created, in ISO 8601 format.
Date lastUpdatedDate
The date and time that information about the stage was last updated, in ISO 8601 format.
Copyright © 2016. All rights reserved.