Package {paws.networking}

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

The name of the ApiKey.

The description of the ApiKey.

Specifies whether the ApiKey can be used by callers.

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.

Specifies a value of the API key.

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

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.

[required] The string identifier of the associated RestApi.

[required] The name of the authorizer.

[required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

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.

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, ⁠arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations⁠. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form ⁠/2015-03-31/functions/[FunctionARN]/invocations⁠.

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

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.

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.

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.

[required] The domain name of the BasePathMapping resource to create.

The identifier for the domain name resource. Required for private custom domain names.

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.

[required] The string identifier of the associated RestApi.

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.

[required] The string identifier of the associated RestApi.

The name of the Stage resource for the Deployment resource to create.

The description of the Stage resource for the Deployment resource to create.

The description for the Deployment resource to create.

Enables a cache cluster for the Stage resource specified in the input.

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

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-._~:/?#&=,]+⁠.

The input configuration for the canary deployment when the deployment is a canary release deployment.

Specifies whether active tracing with X-ray is enabled for the Stage.

[required] The string identifier of the associated RestApi.

[required] The location of the targeted API entity of the to-be-created documentation part.

[required] 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.

[required] The string identifier of the associated RestApi.

[required] The version identifier of the new snapshot.

The stage name to be associated with the new documentation snapshot.

A description about the new documentation snapshot.

[required] The name of the DomainName resource.

The user-friendly name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.

[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint or private endpoint for this domain name provided by your certificate authority.

[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

[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.

The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.

The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.

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.

The Transport Layer Security (TLS) version + cipher suite for this DomainName.

The endpoint access mode of the DomainName. Only available for DomainNames that use security policies that start with SecurityPolicy_.

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.

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.

A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.

The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.

[required] The ARN of the domain name.

[required] The type of the domain name access association source.

[required] The identifier of the domain name access association source. For a VPCE, the value is the VPC endpoint ID.

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.

[required] The RestApi identifier under which the Model will be created.

[required] The name of the model. Must be alphanumeric.

The description of the model.

The schema for the model. For application/json models, this should be JSON schema draft 4 model. The maximum size of the model is 400 KB.

[required] The content-type for the model.

[required] The string identifier of the associated RestApi.

The name of the to-be-created RequestValidator.

A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).

A Boolean flag to indicate whether to validate request parameters, true, or not false.

[required] The string identifier of the associated RestApi.

[required] The parent resource's identifier.

[required] The last path segment for this resource.

[required] The name of the RestApi.

The description of the RestApi.

A version identifier for the API.

The ID of the RestApi that you want to clone from.

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

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.

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.

The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

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.

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

The Transport Layer Security (TLS) version + cipher suite for this RestApi.

The endpoint access mode of the RestApi. Only available for RestApis that use security policies that start with SecurityPolicy_.

[required] The string identifier of the associated RestApi.

[required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

[required] The identifier of the Deployment resource for the Stage resource.

The description of the Stage resource.

Whether cache clustering is enabled for the stage.

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

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-._~:/?#&=,]+⁠.

The version of the associated API documentation.

The canary deployment settings of this stage.

Specifies whether active tracing with X-ray is enabled for the Stage.

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.

[required] The name of the usage plan.

The description of the usage plan.

The associated API stages of the usage plan.

The throttling limits of the usage plan.

The quota of the usage plan.

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.

[required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

[required] The identifier of a UsagePlanKey resource for a plan customer.

[required] The type of a UsagePlanKey resource for a plan customer.

[required] The name used to label and identify the VPC link.

The description of the VPC link.

[required] The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.

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.

[required] The identifier of the ApiKey resource to be deleted.

[required] The string identifier of the associated RestApi.

[required] The identifier of the Authorizer resource.

[required] The domain name of the BasePathMapping resource to delete.

The identifier for the domain name resource. Supported only for private custom domain names.

[required] The base path name of the BasePathMapping resource to delete.

To specify an empty base path, set this parameter to '(none)'.

[required] The identifier of the ClientCertificate resource to be deleted.

[required] The string identifier of the associated RestApi.

[required] The identifier of the Deployment resource to delete.

[required] The string identifier of the associated RestApi.

[required] The identifier of the to-be-deleted documentation part.

[required] The string identifier of the associated RestApi.

[required] The version identifier of a to-be-deleted documentation snapshot.

[required] The name of the DomainName resource to be deleted.

The identifier for the domain name resource. Supported only for private custom domain names.

[required] The ARN of the domain name access association resource.

[required] The string identifier of the associated RestApi.

[required] The response type of the associated GatewayResponse.

[required] The string identifier of the associated RestApi.

[required] Specifies a delete integration request's resource identifier.

[required] Specifies a delete integration request's HTTP method.

[required] The string identifier of the associated RestApi.

[required] Specifies a delete integration response request's resource identifier.

[required] Specifies a delete integration response request's HTTP method.

[required] Specifies a delete integration response request's status code.

[required] The string identifier of the associated RestApi.

[required] The Resource identifier for the Method resource.

[required] The HTTP verb of the Method resource.

[required] The string identifier of the associated RestApi.

[required] The Resource identifier for the MethodResponse resource.

[required] The HTTP verb of the Method resource.

[required] The status code identifier for the MethodResponse resource.

[required] The string identifier of the associated RestApi.

[required] The name of the model to delete.

[required] The string identifier of the associated RestApi.

[required] The identifier of the RequestValidator to be deleted.

[required] The string identifier of the associated RestApi.

[required] The identifier of the Resource resource.

[required] The string identifier of the associated RestApi.

[required] The string identifier of the associated RestApi.

[required] The name of the Stage resource to delete.

[required] The Id of the to-be-deleted usage plan.

[required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

[required] The Id of the UsagePlanKey resource to be deleted.

[required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

[required] The string identifier of the associated RestApi.

[required] The name of the stage to flush.

[required] The string identifier of the associated RestApi.

[required] The name of the stage to flush its cache.

The description of the ClientCertificate.

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.

[required] The identifier of the ApiKey resource.

A boolean flag to specify whether (true) or not (false) the result contains the key value.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

The name of queried API keys.

The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.

A boolean flag to specify whether (true) or not (false) the result contains key values.

[required] The string identifier of the associated RestApi.

[required] The identifier of the Authorizer resource.

[required] The string identifier of the associated RestApi.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The domain name of the BasePathMapping resource to be described.

The identifier for the domain name resource. Supported only for private custom domain names.

[required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

[required] The domain name of a BasePathMapping resource.

The identifier for the domain name resource. Supported only for private custom domain names.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The identifier of the ClientCertificate resource to be described.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The string identifier of the associated RestApi.

[required] The identifier of the Deployment resource to get information about.

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.

[required] The string identifier of the associated RestApi.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The string identifier of the associated RestApi.

[required] The string identifier of the associated RestApi.

[required] The string identifier of the associated RestApi.

The type of API entities of the to-be-retrieved documentation parts.

The name of API entities of the to-be-retrieved documentation parts.

The path of API entities of the to-be-retrieved documentation parts.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

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.

[required] The string identifier of the associated RestApi.

[required] The version identifier of the to-be-retrieved documentation snapshot.

[required] The string identifier of the associated RestApi.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The name of the DomainName resource.

The identifier for the domain name resource. Required for private custom domain names.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

The owner of the domain name access association. Use SELF to only list the domain name access associations owned by your own account. Use OTHER_ACCOUNTS to list the domain name access associations with your private custom domain names that are owned by other AWS accounts.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

The owner of the domain name access association.

[required] The string identifier of the associated RestApi.

[required] The name of the Stage that will be exported.

[required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

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

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

[required] The string identifier of the associated RestApi.

[required] The response type of the associated GatewayResponse.

[required] The string identifier of the associated RestApi.

The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

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.

[required] The string identifier of the associated RestApi.

[required] Specifies a get integration request's resource identifier

[required] Specifies a get integration request's HTTP method.

[required] The string identifier of the associated RestApi.

[required] Specifies a get integration response request's resource identifier.

[required] Specifies a get integration response request's HTTP method.

[required] Specifies a get integration response request's status code.

[required] The string identifier of the associated RestApi.

[required] The Resource identifier for the Method resource.

[required] Specifies the method request's HTTP method type.

[required] The string identifier of the associated RestApi.

[required] The Resource identifier for the MethodResponse resource.

[required] The HTTP verb of the Method resource.

[required] The status code for the MethodResponse resource.

[required] The RestApi identifier under which the Model exists.

[required] The name of the model as an identifier.

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.

[required] The string identifier of the associated RestApi.

[required] The name of the model for which to generate a template.

[required] The string identifier of the associated RestApi.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The string identifier of the associated RestApi.

[required] The identifier of the RequestValidator to be retrieved.

[required] The string identifier of the associated RestApi.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The string identifier of the associated RestApi.

[required] The identifier for the Resource resource.

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.

[required] The string identifier of the associated RestApi.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

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.

[required] The string identifier of the associated RestApi.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The string identifier of the associated RestApi.

[required] The name of the Stage that the SDK will use.

[required] The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.

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.

[required] The identifier of the queried SdkType instance.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The string identifier of the associated RestApi.

[required] The name of the Stage resource to get information about.

[required] The string identifier of the associated RestApi.

The stages' deployment identifiers.

[required] The ARN of a resource that can be tagged.

(Not currently supported) The current pagination position in the paged result set.

(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The Id of the usage plan associated with the usage data.

The Id of the API key associated with the resultant usage data.

[required] The starting date (e.g., 2016-01-01) of the usage data.

[required] The ending date (e.g., 2016-12-31) of the usage data.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The identifier of the UsagePlan resource to be retrieved.

[required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

[required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

[required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

A query parameter specifying the name of the to-be-returned usage plan keys.

The current pagination position in the paged result set.

The identifier of the API key associated with the usage plans.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

The current pagination position in the paged result set.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

[required] The payload of the POST request to import API keys. For the payload format, see API Key File Format.

[required] A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

[required] The string identifier of the associated RestApi.

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.

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.

[required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

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.

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.

[required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

[required] The string identifier of the associated RestApi.

[required] The response type of the associated GatewayResponse

The HTTP status code of the GatewayResponse.

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

[required] The string identifier of the associated RestApi.

[required] Specifies a put integration request's resource ID.

[required] Specifies the HTTP method for the integration.

[required] Specifies a put integration input's type.

The HTTP method for the integration.

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}.

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.

The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type.

Specifies whether credentials are required for a put integration.

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of ⁠method.request.{location}.{name}⁠, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

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.

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.

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.

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.

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.

Specifies the TLS configuration for an integration.

The response transfer mode of the integration.

The ALB or NLB listener to send the request to.

[required] The string identifier of the associated RestApi.

[required] Specifies a put integration response request's resource identifier.

[required] Specifies a put integration response request's HTTP method.

[required] Specifies the status code that is used to map the integration response to an existing MethodResponse.

Specifies the selection pattern of a put integration response.

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ⁠method.response.header.{name}⁠, where name is a valid and unique header name. The mapped non-static value must match the pattern of ⁠integration.response.header.{name}⁠ or ⁠integration.response.body.{JSON-expression}⁠, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Specifies a put integration response's templates.

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.

[required] The string identifier of the associated RestApi.

[required] The Resource identifier for the new Method resource.

[required] Specifies the method request's HTTP method type.

[required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

Specifies whether the method required a valid ApiKey.

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.

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.

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.

The identifier of a RequestValidator for validating the method request.

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.

[required] The string identifier of the associated RestApi.

[required] The Resource identifier for the Method resource.

[required] The HTTP verb of the Method resource.

[required] The method response's status code.

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.)

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.

[required] The string identifier of the associated RestApi.

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

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.

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'⁠.

[required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

[required] The ARN of the domain name access association resource.

[required] The ARN of the domain name.

[required] The ARN of a resource that can be tagged.

[required] 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.

[required] The string identifier of the associated RestApi.

[required] Specifies a test invoke authorizer request's Authorizer ID.

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.

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.

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

The simulated request body of an incoming invocation request.

A key-value map of stage variables to simulate an invocation on a deployed Stage.

A key-value map of additional context variables.

[required] The string identifier of the associated RestApi.

[required] Specifies a test invoke method request's resource ID.

[required] Specifies a test invoke method request's HTTP method.

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

The simulated request body of an incoming invocation request.

A key-value map of headers to simulate an incoming invocation request.

The headers as a map from string to list of values to simulate an incoming invocation request.

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.

A key-value map of stage variables to simulate an invocation on a deployed Stage.

[required] The ARN of a resource that can be tagged.

[required] The Tag keys to delete.

For more information about supported patch operations, see Patch Operations.

[required] The identifier of the ApiKey resource to be updated.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] The identifier of the Authorizer resource.

For more information about supported patch operations, see Patch Operations.

[required] The domain name of the BasePathMapping resource to change.

The identifier for the domain name resource. Supported only for private custom domain names.

[required] The base path of the BasePathMapping resource to change.

To specify an empty base path, set this parameter to '(none)'.

For more information about supported patch operations, see Patch Operations.

[required] The identifier of the ClientCertificate resource to be updated.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] The replacement identifier for the Deployment resource to change information about.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] The identifier of the to-be-updated documentation part.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] The version identifier of the to-be-updated documentation version.

For more information about supported patch operations, see Patch Operations.

[required] The name of the DomainName resource to be changed.

The identifier for the domain name resource. Supported only for private custom domain names.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] The response type of the associated GatewayResponse.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] Represents an update integration request's resource identifier.

[required] Represents an update integration request's HTTP method.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] Specifies an update integration response request's resource identifier.

[required] Specifies an update integration response request's HTTP method.

[required] Specifies an update integration response request's status code.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] The Resource identifier for the Method resource.

[required] The HTTP verb of the Method resource.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] The Resource identifier for the MethodResponse resource.

[required] The HTTP verb of the Method resource.

[required] The status code for the MethodResponse resource.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] The name of the model to update.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] The identifier of RequestValidator to be updated.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] The identifier of the Resource resource.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

For more information about supported patch operations, see Patch Operations.

[required] The string identifier of the associated RestApi.

[required] The name of the Stage resource to change information about.

For more information about supported patch operations, see Patch Operations.

[required] The Id of the usage plan associated with the usage data.

[required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

For more information about supported patch operations, see Patch Operations.

[required] The Id of the to-be-updated usage plan.

For more information about supported patch operations, see Patch Operations.

[required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

For more information about supported patch operations, see Patch Operations.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required]

[required]

[required] The data to be sent to the client specified by its connection id.

[required] The identifier of the connection that a specific client is using.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

The description of the API.

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

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.

The IP address types that can invoke the API.

[required] The name of the API.

[required] The API protocol.

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

The collection of tags. Each tag element is associated with a given resource.

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.

A version identifier for the API.

[required] The API identifier.

The API mapping key.

[required] The domain name.

[required] The API stage.

[required] The API identifier.

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, don't specify this parameter. Supported only for REQUEST authorizers.

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

[required] The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

The authorizer's Uniform Resource Identifier (URI). For 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. Supported only for REQUEST authorizers.

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

[required] The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

This parameter is not used.

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

[required] The name of the authorizer.

[required] The API identifier.

The description for the deployment resource.

The name of the Stage resource for the Deployment resource to create.

[required] The domain name.

The domain name configurations.

The mutual TLS authentication configuration for a custom domain name.

The routing mode.

The collection of tags associated with a domain name.

[required] The API identifier.

The ID of the VPC link for a private integration. Supported only for HTTP APIs.

The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

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.

The description of the integration.

Specifies the integration's HTTP method type.

Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

[required] The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

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. Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs.

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. 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.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern \<action\>:\<header|querystring|path\>.\<location\> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

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. Supported only for WebSocket APIs.

Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern \<action\>:\<header\>.\<location\> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

The template selection expression for the integration.

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

[required] The API identifier.

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

[required] The integration ID.

[required] The integration response key.

A key-value map specifying response parameters that are passed to the method response from the backend. 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.

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

The template selection expression for the integration response. Supported only for WebSocket APIs.

[required] The API identifier.

The content-type for the model, for example, "application/json".

The description of the model.

[required] The name of the model. Must be alphanumeric.

[required] The schema for the model. For application/json models, this should be JSON schema draft 4 model.

[required] The authentication configuration for the portal.

[required] The domain configuration for the portal. Use a default domain provided by API Gateway or provide a fully-qualified domain name that you own.

The ARNs of the portal products included in the portal.

The URI for the portal logo image that is displayed in the portal header.

[required] The content of the portal.

The name of the Amazon CloudWatch RUM app monitor for the portal.

The collection of tags. Each tag element is associated with a given resource.

A description of the portal product.

[required] The name of the portal product as it appears in a published portal.

The collection of tags. Each tag element is associated with a given resource.

[required] The content of the product page.

[required] The portal product identifier.

The content of the product REST endpoint page.

[required] The portal product identifier.

[required] The REST endpoint identifier.

The try it state of the product REST endpoint page.

[required] The API identifier.

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

The authorization scopes supported by this route.

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

The model selection expression for the route. Supported only for WebSocket APIs.

The operation name for the route.

The request models for the route. Supported only for WebSocket APIs.

The request parameters for the route. Supported only for WebSocket APIs.

[required] The route key for the route.

The route response selection expression for the route. Supported only for WebSocket APIs.

The target for the route.

[required] The API identifier.

The model selection expression for the route response. Supported only for WebSocket APIs.

The response models for the route response.

The route response parameters.

[required] The route ID.

[required] The route response key.

[required] Represents a routing rule action. The only supported action is invokeApi.

[required] Represents a condition. Conditions can contain up to two matchHeaders conditions and one matchBasePaths conditions. API Gateway evaluates header conditions and base path conditions together. You can only use AND between header and base path conditions.

[required] The domain name.

The domain name ID.

[required] Represents the priority of the routing rule.

Settings for logging access in this stage.

[required] The API identifier.

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

The default route settings for the stage.

The deployment identifier of the API stage.

The description for the API stage.

Route settings for the stage, by routeKey.

[required] The name of the stage.

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

The collection of tags. Each tag element is associated with a given resource.

[required] The name of the VPC link.

A list of security group IDs for the VPC link.

[required] A list of subnet IDs to include in the VPC link.

A list of tags.

[required] The API identifier.

[required] The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

[required] The API identifier.

[required] The API mapping identifier.

[required] The domain name.

[required] The API identifier.

[required] The authorizer identifier.

[required] The API identifier.

[required] The API identifier.

[required] The deployment ID.

[required] The domain name.

[required] The API identifier.

[required] The integration ID.

[required] The API identifier.

[required] The integration ID.

[required] The integration response ID.

[required] The API identifier.

[required] The model ID.

[required] The portal identifier.

[required] The portal product identifier.

[required] The portal product identifier.

[required] The portal product identifier.

[required] The portal product identifier.

[required] The portal product identifier.

[required] The product REST endpoint identifier.

[required] The API identifier.

[required] The route ID.

[required] The API identifier.

[required] The route request parameter key.

[required] The route ID.

[required] The API identifier.

[required] The route ID.

[required] The route response ID.

[required] The API identifier.

[required] The route key.

[required] The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

[required] The domain name.

The domain name ID.

[required] The routing rule ID.

[required] The API identifier.

[required] The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

[required] The ID of the VPC link.

[required] The portal identifier.

[required] The API identifier.

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

[required] The output type of the exported definition file. Valid values are JSON and YAML.

[required] The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

[required] The API identifier.

[required] The API mapping identifier.

[required] The domain name.

[required] The domain name.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

[required] The API identifier.

[required] The authorizer identifier.

[required] The API identifier.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

[required] The API identifier.

[required] The deployment ID.

[required] The API identifier.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

[required] The domain name.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

[required] The API identifier.

[required] The integration ID.

[required] The API identifier.

[required] The integration ID.

[required] The integration response ID.

[required] The API identifier.

[required] The integration ID.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

[required] The API identifier.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

[required] The API identifier.

[required] The model ID.

[required] The API identifier.

[required] The model ID.

[required] The API identifier.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

[required] The portal identifier.

[required] The portal product identifier.

The account ID of the resource owner of the portal product.

[required] The portal product identifier.

[required] The portal product identifier.

[required] The portal product identifier.

The account ID of the resource owner of the portal product.

The query parameter to include raw display content.

[required] The portal product identifier.

[required] The product REST endpoint identifier.

The account ID of the resource owner of the portal product.

[required] The API identifier.

[required] The route ID.

[required] The API identifier.

[required] The route ID.

[required] The route response ID.

[required] The API identifier.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

[required] The route ID.

[required] The API identifier.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

[required] The domain name.

The domain name ID.

[required] The routing rule ID.

[required] The API identifier.

[required] The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

[required] The API identifier.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

[required] The resource ARN for the tag.

[required] The ID of the VPC link.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.

[required] The OpenAPI definition. Supported only for HTTP APIs.

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

The resource owner of the portal product.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

[required] The portal product identifier.

The account ID of the resource owner of the portal product.

The maximum number of elements to be returned for this resource.

The next page of elements from this collection. Not valid for the last element of the collection.

[required] The portal product identifier.

The account ID of the resource owner of the portal product.