Struct aws_sdk_apigatewayv2::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AmazonApiGatewayV2
Client for invoking operations on AmazonApiGatewayV2. Each operation on AmazonApiGatewayV2 is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_apigatewayv2::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_apigatewayv2::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CreateApi
operation has
a Client::create_api
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.create_api()
.api_key_selection_expression("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn create_api(&self) -> CreateApiFluentBuilder
pub fn create_api(&self) -> CreateApiFluentBuilder
Constructs a fluent builder for the CreateApi
operation.
- The fluent builder is configurable:
api_key_selection_expression(impl Into<String>)
/set_api_key_selection_expression(Option<String>)
:
required: falseAn API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
cors_configuration(Cors)
/set_cors_configuration(Option<Cors>)
:
required: falseA CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
credentials_arn(impl Into<String>)
/set_credentials_arn(Option<String>)
:
required: falseThis 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.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the API.
disable_schema_validation(bool)
/set_disable_schema_validation(Option<bool>)
:
required: falseAvoid validating models when creating a deployment. Supported only for WebSocket APIs.
disable_execute_api_endpoint(bool)
/set_disable_execute_api_endpoint(Option<bool>)
:
required: falseSpecifies 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.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the API.
protocol_type(ProtocolType)
/set_protocol_type(Option<ProtocolType>)
:
required: trueThe API protocol.
route_key(impl Into<String>)
/set_route_key(Option<String>)
:
required: falseThis 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.
route_selection_expression(impl Into<String>)
/set_route_selection_expression(Option<String>)
:
required: falseThe 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.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe collection of tags. Each tag element is associated with a given resource.
target(impl Into<String>)
/set_target(Option<String>)
:
required: falseThis 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.
version(impl Into<String>)
/set_version(Option<String>)
:
required: falseA version identifier for the API.
- On success, responds with
CreateApiOutput
with field(s):api_endpoint(Option<String>)
:The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
api_gateway_managed(Option<bool>)
:Specifies whether an API is managed by API Gateway. You can’t update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
api_id(Option<String>)
:The API ID.
api_key_selection_expression(Option<String>)
:An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
cors_configuration(Option<Cors>)
:A CORS configuration. Supported only for HTTP APIs.
created_date(Option<DateTime>)
:The timestamp when the API was created.
description(Option<String>)
:The description of the API.
disable_schema_validation(Option<bool>)
:Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
disable_execute_api_endpoint(Option<bool>)
: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.
import_info(Option<Vec::<String>>)
:The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
name(Option<String>)
:The name of the API.
protocol_type(Option<ProtocolType>)
:The API protocol.
route_selection_expression(Option<String>)
: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.
tags(Option<HashMap::<String, String>>)
:A collection of tags associated with the API.
version(Option<String>)
:A version identifier for the API.
warnings(Option<Vec::<String>>)
:The warning messages reported when failonwarnings is turned on during API import.
- On failure, responds with
SdkError<CreateApiError>
source§impl Client
impl Client
sourcepub fn create_api_mapping(&self) -> CreateApiMappingFluentBuilder
pub fn create_api_mapping(&self) -> CreateApiMappingFluentBuilder
Constructs a fluent builder for the CreateApiMapping
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
api_mapping_key(impl Into<String>)
/set_api_mapping_key(Option<String>)
:
required: false
The API mapping key.domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name.
stage(impl Into<String>)
/set_stage(Option<String>)
:
required: trueThe API stage.
- On success, responds with
CreateApiMappingOutput
with field(s):api_id(Option<String>)
:The API identifier.
api_mapping_id(Option<String>)
:The API mapping identifier.
api_mapping_key(Option<String>)
:The API mapping key.
stage(Option<String>)
:The API stage.
- On failure, responds with
SdkError<CreateApiMappingError>
source§impl Client
impl Client
Constructs a fluent builder for the CreateAuthorizer
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
authorizer_credentials_arn(impl Into<String>)
/set_authorizer_credentials_arn(Option<String>)
:
required: falseSpecifies 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.
authorizer_payload_format_version(impl Into<String>)
/set_authorizer_payload_format_version(Option<String>)
:
required: falseSpecifies 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.
authorizer_result_ttl_in_seconds(i32)
/set_authorizer_result_ttl_in_seconds(Option<i32>)
:
required: falseThe 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.
authorizer_type(AuthorizerType)
/set_authorizer_type(Option<AuthorizerType>)
:
required: trueThe authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
authorizer_uri(impl Into<String>)
/set_authorizer_uri(Option<String>)
:
required: falseThe 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. enable_simple_responses(bool)
/set_enable_simple_responses(Option<bool>)
:
required: falseSpecifies 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
identity_source(impl Into<String>)
/set_identity_source(Option<Vec::<String>>)
:
required: trueThe 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. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
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.
identity_validation_expression(impl Into<String>)
/set_identity_validation_expression(Option<String>)
:
required: falseThis parameter is not used.
jwt_configuration(JwtConfiguration)
/set_jwt_configuration(Option<JwtConfiguration>)
:
required: falseRepresents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the authorizer.
- On success, responds with
CreateAuthorizerOutput
with field(s):authorizer_credentials_arn(Option<String>)
:Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don’t specify this parameter. Supported only for REQUEST authorizers.
authorizer_id(Option<String>)
:The authorizer identifier.
authorizer_payload_format_version(Option<String>)
: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.
authorizer_result_ttl_in_seconds(Option<i32>)
: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.
authorizer_type(Option<AuthorizerType>)
: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).
authorizer_uri(Option<String>)
: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. enable_simple_responses(Option<bool>)
:Specifies whether a Lambda authorizer returns a response in a simple format. 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
identity_source(Option<Vec::<String>>)
: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. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
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.
identity_validation_expression(Option<String>)
:The validation expression does not apply to the REQUEST authorizer.
jwt_configuration(Option<JwtConfiguration>)
:Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
name(Option<String>)
:The name of the authorizer.
- On failure, responds with
SdkError<CreateAuthorizerError>
source§impl Client
impl Client
sourcepub fn create_deployment(&self) -> CreateDeploymentFluentBuilder
pub fn create_deployment(&self) -> CreateDeploymentFluentBuilder
Constructs a fluent builder for the CreateDeployment
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description for the deployment resource.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: falseThe name of the Stage resource for the Deployment resource to create.
- On success, responds with
CreateDeploymentOutput
with field(s):auto_deployed(Option<bool>)
:Specifies whether a deployment was automatically released.
created_date(Option<DateTime>)
:The date and time when the Deployment resource was created.
deployment_id(Option<String>)
:The identifier for the deployment.
deployment_status(Option<DeploymentStatus>)
:The status of the deployment: PENDING, FAILED, or SUCCEEDED.
deployment_status_message(Option<String>)
:May contain additional feedback on the status of an API deployment.
description(Option<String>)
:The description for the deployment.
- On failure, responds with
SdkError<CreateDeploymentError>
source§impl Client
impl Client
sourcepub fn create_domain_name(&self) -> CreateDomainNameFluentBuilder
pub fn create_domain_name(&self) -> CreateDomainNameFluentBuilder
Constructs a fluent builder for the CreateDomainName
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name.
domain_name_configurations(DomainNameConfiguration)
/set_domain_name_configurations(Option<Vec::<DomainNameConfiguration>>)
:
required: falseThe domain name configurations.
mutual_tls_authentication(MutualTlsAuthenticationInput)
/set_mutual_tls_authentication(Option<MutualTlsAuthenticationInput>)
:
required: falseThe mutual TLS authentication configuration for a custom domain name.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe collection of tags associated with a domain name.
- On success, responds with
CreateDomainNameOutput
with field(s):api_mapping_selection_expression(Option<String>)
:The API mapping selection expression.
domain_name(Option<String>)
:The name of the DomainName resource.
domain_name_configurations(Option<Vec::<DomainNameConfiguration>>)
:The domain name configurations.
mutual_tls_authentication(Option<MutualTlsAuthentication>)
:The mutual TLS authentication configuration for a custom domain name.
tags(Option<HashMap::<String, String>>)
:The collection of tags associated with a domain name.
- On failure, responds with
SdkError<CreateDomainNameError>
source§impl Client
impl Client
sourcepub fn create_integration(&self) -> CreateIntegrationFluentBuilder
pub fn create_integration(&self) -> CreateIntegrationFluentBuilder
Constructs a fluent builder for the CreateIntegration
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
connection_id(impl Into<String>)
/set_connection_id(Option<String>)
:
required: falseThe ID of the VPC link for a private integration. Supported only for HTTP APIs.
connection_type(ConnectionType)
/set_connection_type(Option<ConnectionType>)
:
required: falseThe 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.
content_handling_strategy(ContentHandlingStrategy)
/set_content_handling_strategy(Option<ContentHandlingStrategy>)
:
required: falseSupported 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.
credentials_arn(impl Into<String>)
/set_credentials_arn(Option<String>)
:
required: falseSpecifies 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.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the integration.
integration_method(impl Into<String>)
/set_integration_method(Option<String>)
:
required: falseSpecifies the integration’s HTTP method type.
integration_subtype(impl Into<String>)
/set_integration_subtype(Option<String>)
:
required: falseSupported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
integration_type(IntegrationType)
/set_integration_type(Option<IntegrationType>)
:
required: trueThe 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.
integration_uri(impl Into<String>)
/set_integration_uri(Option<String>)
:
required: falseFor 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.
passthrough_behavior(PassthroughBehavior)
/set_passthrough_behavior(Option<PassthroughBehavior>)
:
required: falseSpecifies 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.
payload_format_version(impl Into<String>)
/set_payload_format_version(Option<String>)
:
required: falseSpecifies the format of the payload sent to an integration. Required for HTTP APIs.
request_parameters(impl Into<String>, impl Into<String>)
/set_request_parameters(Option<HashMap::<String, String>>)
:
required: falseFor 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.
request_templates(impl Into<String>, impl Into<String>)
/set_request_templates(Option<HashMap::<String, String>>)
:
required: falseRepresents 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.
response_parameters(impl Into<String>, HashMap::<String, String>)
/set_response_parameters(Option<HashMap::<String, HashMap::<String, String>>>)
:
required: falseSupported 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.
template_selection_expression(impl Into<String>)
/set_template_selection_expression(Option<String>)
:
required: falseThe template selection expression for the integration.
timeout_in_millis(i32)
/set_timeout_in_millis(Option<i32>)
:
required: falseCustom 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.
tls_config(TlsConfigInput)
/set_tls_config(Option<TlsConfigInput>)
:
required: falseThe TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
- On success, responds with
CreateIntegrationOutput
with field(s):api_gateway_managed(Option<bool>)
:Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can’t delete it.
connection_id(Option<String>)
:The ID of the VPC link for a private integration. Supported only for HTTP APIs.
connection_type(Option<ConnectionType>)
: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.
content_handling_strategy(Option<ContentHandlingStrategy>)
: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.
credentials_arn(Option<String>)
:Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To require that the caller’s identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null.
description(Option<String>)
:Represents the description of an integration.
integration_id(Option<String>)
:Represents the identifier of an integration.
integration_method(Option<String>)
:Specifies the integration’s HTTP method type.
integration_response_selection_expression(Option<String>)
:The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
integration_subtype(Option<String>)
:Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
integration_type(Option<IntegrationType>)
: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.
MOCK: for integrating the route or method request with API Gateway as a “loopback” endpoint without invoking any backend. Supported only for WebSocket APIs.
integration_uri(Option<String>)
: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.
passthrough_behavior(Option<PassthroughBehavior>)
:Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. 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.
payload_format_version(Option<String>)
:Specifies the format of the payload sent to an integration. Required for HTTP APIs.
request_parameters(Option<HashMap::<String, String>>)
: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 backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The 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.
request_templates(Option<HashMap::<String, String>>)
: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.
response_parameters(Option<HashMap::<String, HashMap::<String, String>>>)
: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.
template_selection_expression(Option<String>)
:The template selection expression for the integration. Supported only for WebSocket APIs.
timeout_in_millis(Option<i32>)
: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.
tls_config(Option<TlsConfig>)
: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.
- On failure, responds with
SdkError<CreateIntegrationError>
source§impl Client
impl Client
sourcepub fn create_integration_response(
&self
) -> CreateIntegrationResponseFluentBuilder
pub fn create_integration_response( &self ) -> CreateIntegrationResponseFluentBuilder
Constructs a fluent builder for the CreateIntegrationResponse
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
content_handling_strategy(ContentHandlingStrategy)
/set_content_handling_strategy(Option<ContentHandlingStrategy>)
:
required: falseSpecifies 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.
integration_id(impl Into<String>)
/set_integration_id(Option<String>)
:
required: trueThe integration ID.
integration_response_key(impl Into<String>)
/set_integration_response_key(Option<String>)
:
required: trueThe integration response key.
response_parameters(impl Into<String>, impl Into<String>)
/set_response_parameters(Option<HashMap::<String, String>>)
:
required: falseA 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.
response_templates(impl Into<String>, impl Into<String>)
/set_response_templates(Option<HashMap::<String, String>>)
:
required: falseThe 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.
template_selection_expression(impl Into<String>)
/set_template_selection_expression(Option<String>)
:
required: falseThe template selection expression for the integration response. Supported only for WebSocket APIs.
- On success, responds with
CreateIntegrationResponseOutput
with field(s):content_handling_strategy(Option<ContentHandlingStrategy>)
: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.
integration_response_id(Option<String>)
:The integration response ID.
integration_response_key(Option<String>)
:The integration response key.
response_parameters(Option<HashMap::<String, String>>)
: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.
response_templates(Option<HashMap::<String, String>>)
: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.
template_selection_expression(Option<String>)
:The template selection expressions for the integration response.
- On failure, responds with
SdkError<CreateIntegrationResponseError>
source§impl Client
impl Client
sourcepub fn create_model(&self) -> CreateModelFluentBuilder
pub fn create_model(&self) -> CreateModelFluentBuilder
Constructs a fluent builder for the CreateModel
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
content_type(impl Into<String>)
/set_content_type(Option<String>)
:
required: falseThe content-type for the model, for example, “application/json”.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the model.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the model. Must be alphanumeric.
schema(impl Into<String>)
/set_schema(Option<String>)
:
required: trueThe schema for the model. For application/json models, this should be JSON schema draft 4 model.
- On success, responds with
CreateModelOutput
with field(s):content_type(Option<String>)
:The content-type for the model, for example, “application/json”.
description(Option<String>)
:The description of the model.
model_id(Option<String>)
:The model identifier.
name(Option<String>)
:The name of the model. Must be alphanumeric.
schema(Option<String>)
:The schema for the model. For application/json models, this should be JSON schema draft 4 model.
- On failure, responds with
SdkError<CreateModelError>
source§impl Client
impl Client
sourcepub fn create_route(&self) -> CreateRouteFluentBuilder
pub fn create_route(&self) -> CreateRouteFluentBuilder
Constructs a fluent builder for the CreateRoute
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
api_key_required(bool)
/set_api_key_required(Option<bool>)
:
required: falseSpecifies whether an API key is required for the route. Supported only for WebSocket APIs.
authorization_scopes(impl Into<String>)
/set_authorization_scopes(Option<Vec::<String>>)
:
required: falseThe authorization scopes supported by this route.
authorization_type(AuthorizationType)
/set_authorization_type(Option<AuthorizationType>)
:
required: falseThe 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.
authorizer_id(impl Into<String>)
/set_authorizer_id(Option<String>)
:
required: falseThe identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
model_selection_expression(impl Into<String>)
/set_model_selection_expression(Option<String>)
:
required: falseThe model selection expression for the route. Supported only for WebSocket APIs.
operation_name(impl Into<String>)
/set_operation_name(Option<String>)
:
required: falseThe operation name for the route.
request_models(impl Into<String>, impl Into<String>)
/set_request_models(Option<HashMap::<String, String>>)
:
required: falseThe request models for the route. Supported only for WebSocket APIs.
request_parameters(impl Into<String>, ParameterConstraints)
/set_request_parameters(Option<HashMap::<String, ParameterConstraints>>)
:
required: falseThe request parameters for the route. Supported only for WebSocket APIs.
route_key(impl Into<String>)
/set_route_key(Option<String>)
:
required: trueThe route key for the route.
route_response_selection_expression(impl Into<String>)
/set_route_response_selection_expression(Option<String>)
:
required: falseThe route response selection expression for the route. Supported only for WebSocket APIs.
target(impl Into<String>)
/set_target(Option<String>)
:
required: falseThe target for the route.
- On success, responds with
CreateRouteOutput
with field(s):api_gateway_managed(Option<bool>)
:Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can’t modify the $default route key.
api_key_required(Option<bool>)
:Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
authorization_scopes(Option<Vec::<String>>)
:A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
authorization_type(Option<AuthorizationType>)
: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.
authorizer_id(Option<String>)
: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.
model_selection_expression(Option<String>)
:The model selection expression for the route. Supported only for WebSocket APIs.
operation_name(Option<String>)
:The operation name for the route.
request_models(Option<HashMap::<String, String>>)
:The request models for the route. Supported only for WebSocket APIs.
request_parameters(Option<HashMap::<String, ParameterConstraints>>)
:The request parameters for the route. Supported only for WebSocket APIs.
route_id(Option<String>)
:The route ID.
route_key(Option<String>)
:The route key for the route.
route_response_selection_expression(Option<String>)
:The route response selection expression for the route. Supported only for WebSocket APIs.
target(Option<String>)
:The target for the route.
- On failure, responds with
SdkError<CreateRouteError>
source§impl Client
impl Client
sourcepub fn create_route_response(&self) -> CreateRouteResponseFluentBuilder
pub fn create_route_response(&self) -> CreateRouteResponseFluentBuilder
Constructs a fluent builder for the CreateRouteResponse
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
model_selection_expression(impl Into<String>)
/set_model_selection_expression(Option<String>)
:
required: falseThe model selection expression for the route response. Supported only for WebSocket APIs.
response_models(impl Into<String>, impl Into<String>)
/set_response_models(Option<HashMap::<String, String>>)
:
required: falseThe response models for the route response.
response_parameters(impl Into<String>, ParameterConstraints)
/set_response_parameters(Option<HashMap::<String, ParameterConstraints>>)
:
required: falseThe route response parameters.
route_id(impl Into<String>)
/set_route_id(Option<String>)
:
required: trueThe route ID.
route_response_key(impl Into<String>)
/set_route_response_key(Option<String>)
:
required: trueThe route response key.
- On success, responds with
CreateRouteResponseOutput
with field(s):model_selection_expression(Option<String>)
:Represents the model selection expression of a route response. Supported only for WebSocket APIs.
response_models(Option<HashMap::<String, String>>)
:Represents the response models of a route response.
response_parameters(Option<HashMap::<String, ParameterConstraints>>)
:Represents the response parameters of a route response.
route_response_id(Option<String>)
:Represents the identifier of a route response.
route_response_key(Option<String>)
:Represents the route response key of a route response.
- On failure, responds with
SdkError<CreateRouteResponseError>
source§impl Client
impl Client
sourcepub fn create_stage(&self) -> CreateStageFluentBuilder
pub fn create_stage(&self) -> CreateStageFluentBuilder
Constructs a fluent builder for the CreateStage
operation.
- The fluent builder is configurable:
access_log_settings(AccessLogSettings)
/set_access_log_settings(Option<AccessLogSettings>)
:
required: falseSettings for logging access in this stage.
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
auto_deploy(bool)
/set_auto_deploy(Option<bool>)
:
required: falseSpecifies whether updates to an API automatically trigger a new deployment. The default value is false.
client_certificate_id(impl Into<String>)
/set_client_certificate_id(Option<String>)
:
required: falseThe identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
default_route_settings(RouteSettings)
/set_default_route_settings(Option<RouteSettings>)
:
required: falseThe default route settings for the stage.
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: falseThe deployment identifier of the API stage.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description for the API stage.
route_settings(impl Into<String>, RouteSettings)
/set_route_settings(Option<HashMap::<String, RouteSettings>>)
:
required: falseRoute settings for the stage, by routeKey.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe name of the stage.
stage_variables(impl Into<String>, impl Into<String>)
/set_stage_variables(Option<HashMap::<String, String>>)
:
required: falseA 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-._~:/?#&=,]+.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe collection of tags. Each tag element is associated with a given resource.
- On success, responds with
CreateStageOutput
with field(s):access_log_settings(Option<AccessLogSettings>)
:Settings for logging access in this stage.
api_gateway_managed(Option<bool>)
:Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can’t modify the $default stage.
auto_deploy(Option<bool>)
:Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
client_certificate_id(Option<String>)
:The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
created_date(Option<DateTime>)
:The timestamp when the stage was created.
default_route_settings(Option<RouteSettings>)
:Default route settings for the stage.
deployment_id(Option<String>)
:The identifier of the Deployment that the Stage is associated with. Can’t be updated if autoDeploy is enabled.
description(Option<String>)
:The description of the stage.
last_deployment_status_message(Option<String>)
:Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
last_updated_date(Option<DateTime>)
:The timestamp when the stage was last updated.
route_settings(Option<HashMap::<String, RouteSettings>>)
:Route settings for the stage, by routeKey.
stage_name(Option<String>)
:The name of the stage.
stage_variables(Option<HashMap::<String, String>>)
:A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<CreateStageError>
source§impl Client
impl Client
sourcepub fn create_vpc_link(&self) -> CreateVpcLinkFluentBuilder
pub fn create_vpc_link(&self) -> CreateVpcLinkFluentBuilder
Constructs a fluent builder for the CreateVpcLink
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the VPC link.
security_group_ids(impl Into<String>)
/set_security_group_ids(Option<Vec::<String>>)
:
required: falseA list of security group IDs for the VPC link.
subnet_ids(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: trueA list of subnet IDs to include in the VPC link.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of tags.
- On success, responds with
CreateVpcLinkOutput
with field(s):created_date(Option<DateTime>)
:The timestamp when the VPC link was created.
name(Option<String>)
:The name of the VPC link.
security_group_ids(Option<Vec::<String>>)
:A list of security group IDs for the VPC link.
subnet_ids(Option<Vec::<String>>)
:A list of subnet IDs to include in the VPC link.
tags(Option<HashMap::<String, String>>)
:Tags for the VPC link.
vpc_link_id(Option<String>)
:The ID of the VPC link.
vpc_link_status(Option<VpcLinkStatus>)
:The status of the VPC link.
vpc_link_status_message(Option<String>)
:A message summarizing the cause of the status of the VPC link.
vpc_link_version(Option<VpcLinkVersion>)
:The version of the VPC link.
- On failure, responds with
SdkError<CreateVpcLinkError>
source§impl Client
impl Client
sourcepub fn delete_access_log_settings(&self) -> DeleteAccessLogSettingsFluentBuilder
pub fn delete_access_log_settings(&self) -> DeleteAccessLogSettingsFluentBuilder
Constructs a fluent builder for the DeleteAccessLogSettings
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
- On success, responds with
DeleteAccessLogSettingsOutput
- On failure, responds with
SdkError<DeleteAccessLogSettingsError>
source§impl Client
impl Client
sourcepub fn delete_api(&self) -> DeleteApiFluentBuilder
pub fn delete_api(&self) -> DeleteApiFluentBuilder
Constructs a fluent builder for the DeleteApi
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
- On success, responds with
DeleteApiOutput
- On failure, responds with
SdkError<DeleteApiError>
source§impl Client
impl Client
sourcepub fn delete_api_mapping(&self) -> DeleteApiMappingFluentBuilder
pub fn delete_api_mapping(&self) -> DeleteApiMappingFluentBuilder
Constructs a fluent builder for the DeleteApiMapping
operation.
- The fluent builder is configurable:
api_mapping_id(impl Into<String>)
/set_api_mapping_id(Option<String>)
:
required: trueThe API mapping identifier.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name.
- On success, responds with
DeleteApiMappingOutput
- On failure, responds with
SdkError<DeleteApiMappingError>
source§impl Client
impl Client
Constructs a fluent builder for the DeleteAuthorizer
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
authorizer_id(impl Into<String>)
/set_authorizer_id(Option<String>)
:
required: trueThe authorizer identifier.
- On success, responds with
DeleteAuthorizerOutput
- On failure, responds with
SdkError<DeleteAuthorizerError>
source§impl Client
impl Client
sourcepub fn delete_cors_configuration(&self) -> DeleteCorsConfigurationFluentBuilder
pub fn delete_cors_configuration(&self) -> DeleteCorsConfigurationFluentBuilder
Constructs a fluent builder for the DeleteCorsConfiguration
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
- On success, responds with
DeleteCorsConfigurationOutput
- On failure, responds with
SdkError<DeleteCorsConfigurationError>
source§impl Client
impl Client
sourcepub fn delete_deployment(&self) -> DeleteDeploymentFluentBuilder
pub fn delete_deployment(&self) -> DeleteDeploymentFluentBuilder
Constructs a fluent builder for the DeleteDeployment
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe deployment ID.
- On success, responds with
DeleteDeploymentOutput
- On failure, responds with
SdkError<DeleteDeploymentError>
source§impl Client
impl Client
sourcepub fn delete_domain_name(&self) -> DeleteDomainNameFluentBuilder
pub fn delete_domain_name(&self) -> DeleteDomainNameFluentBuilder
Constructs a fluent builder for the DeleteDomainName
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name.
- On success, responds with
DeleteDomainNameOutput
- On failure, responds with
SdkError<DeleteDomainNameError>
source§impl Client
impl Client
sourcepub fn delete_integration(&self) -> DeleteIntegrationFluentBuilder
pub fn delete_integration(&self) -> DeleteIntegrationFluentBuilder
Constructs a fluent builder for the DeleteIntegration
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
integration_id(impl Into<String>)
/set_integration_id(Option<String>)
:
required: trueThe integration ID.
- On success, responds with
DeleteIntegrationOutput
- On failure, responds with
SdkError<DeleteIntegrationError>
source§impl Client
impl Client
sourcepub fn delete_integration_response(
&self
) -> DeleteIntegrationResponseFluentBuilder
pub fn delete_integration_response( &self ) -> DeleteIntegrationResponseFluentBuilder
Constructs a fluent builder for the DeleteIntegrationResponse
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
integration_id(impl Into<String>)
/set_integration_id(Option<String>)
:
required: trueThe integration ID.
integration_response_id(impl Into<String>)
/set_integration_response_id(Option<String>)
:
required: trueThe integration response ID.
- On success, responds with
DeleteIntegrationResponseOutput
- On failure, responds with
SdkError<DeleteIntegrationResponseError>
source§impl Client
impl Client
sourcepub fn delete_model(&self) -> DeleteModelFluentBuilder
pub fn delete_model(&self) -> DeleteModelFluentBuilder
Constructs a fluent builder for the DeleteModel
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
model_id(impl Into<String>)
/set_model_id(Option<String>)
:
required: trueThe model ID.
- On success, responds with
DeleteModelOutput
- On failure, responds with
SdkError<DeleteModelError>
source§impl Client
impl Client
sourcepub fn delete_route(&self) -> DeleteRouteFluentBuilder
pub fn delete_route(&self) -> DeleteRouteFluentBuilder
Constructs a fluent builder for the DeleteRoute
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
route_id(impl Into<String>)
/set_route_id(Option<String>)
:
required: trueThe route ID.
- On success, responds with
DeleteRouteOutput
- On failure, responds with
SdkError<DeleteRouteError>
source§impl Client
impl Client
sourcepub fn delete_route_request_parameter(
&self
) -> DeleteRouteRequestParameterFluentBuilder
pub fn delete_route_request_parameter( &self ) -> DeleteRouteRequestParameterFluentBuilder
Constructs a fluent builder for the DeleteRouteRequestParameter
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
request_parameter_key(impl Into<String>)
/set_request_parameter_key(Option<String>)
:
required: trueThe route request parameter key.
route_id(impl Into<String>)
/set_route_id(Option<String>)
:
required: trueThe route ID.
- On success, responds with
DeleteRouteRequestParameterOutput
- On failure, responds with
SdkError<DeleteRouteRequestParameterError>
source§impl Client
impl Client
sourcepub fn delete_route_response(&self) -> DeleteRouteResponseFluentBuilder
pub fn delete_route_response(&self) -> DeleteRouteResponseFluentBuilder
Constructs a fluent builder for the DeleteRouteResponse
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
route_id(impl Into<String>)
/set_route_id(Option<String>)
:
required: trueThe route ID.
route_response_id(impl Into<String>)
/set_route_response_id(Option<String>)
:
required: trueThe route response ID.
- On success, responds with
DeleteRouteResponseOutput
- On failure, responds with
SdkError<DeleteRouteResponseError>
source§impl Client
impl Client
sourcepub fn delete_route_settings(&self) -> DeleteRouteSettingsFluentBuilder
pub fn delete_route_settings(&self) -> DeleteRouteSettingsFluentBuilder
Constructs a fluent builder for the DeleteRouteSettings
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
route_key(impl Into<String>)
/set_route_key(Option<String>)
:
required: trueThe route key.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
- On success, responds with
DeleteRouteSettingsOutput
- On failure, responds with
SdkError<DeleteRouteSettingsError>
source§impl Client
impl Client
sourcepub fn delete_stage(&self) -> DeleteStageFluentBuilder
pub fn delete_stage(&self) -> DeleteStageFluentBuilder
Constructs a fluent builder for the DeleteStage
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
- On success, responds with
DeleteStageOutput
- On failure, responds with
SdkError<DeleteStageError>
source§impl Client
impl Client
sourcepub fn delete_vpc_link(&self) -> DeleteVpcLinkFluentBuilder
pub fn delete_vpc_link(&self) -> DeleteVpcLinkFluentBuilder
Constructs a fluent builder for the DeleteVpcLink
operation.
- The fluent builder is configurable:
vpc_link_id(impl Into<String>)
/set_vpc_link_id(Option<String>)
:
required: trueThe ID of the VPC link.
- On success, responds with
DeleteVpcLinkOutput
- On failure, responds with
SdkError<DeleteVpcLinkError>
source§impl Client
impl Client
sourcepub fn export_api(&self) -> ExportApiFluentBuilder
pub fn export_api(&self) -> ExportApiFluentBuilder
Constructs a fluent builder for the ExportApi
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
export_version(impl Into<String>)
/set_export_version(Option<String>)
:
required: falseThe version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.
include_extensions(bool)
/set_include_extensions(Option<bool>)
:
required: falseSpecifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
output_type(impl Into<String>)
/set_output_type(Option<String>)
:
required: trueThe output type of the exported definition file. Valid values are JSON and YAML.
specification(impl Into<String>)
/set_specification(Option<String>)
:
required: trueThe version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: falseThe name of the API stage to export. If you don’t specify this property, a representation of the latest API configuration is exported.
- On success, responds with
ExportApiOutput
with field(s):body(Option<Blob>)
:Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0.
- On failure, responds with
SdkError<ExportApiError>
source§impl Client
impl Client
sourcepub fn get_api(&self) -> GetApiFluentBuilder
pub fn get_api(&self) -> GetApiFluentBuilder
Constructs a fluent builder for the GetApi
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
- On success, responds with
GetApiOutput
with field(s):api_endpoint(Option<String>)
:The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
api_gateway_managed(Option<bool>)
:Specifies whether an API is managed by API Gateway. You can’t update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
api_id(Option<String>)
:The API ID.
api_key_selection_expression(Option<String>)
:An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
cors_configuration(Option<Cors>)
:A CORS configuration. Supported only for HTTP APIs.
created_date(Option<DateTime>)
:The timestamp when the API was created.
description(Option<String>)
:The description of the API.
disable_schema_validation(Option<bool>)
:Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
disable_execute_api_endpoint(Option<bool>)
: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.
import_info(Option<Vec::<String>>)
:The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
name(Option<String>)
:The name of the API.
protocol_type(Option<ProtocolType>)
:The API protocol.
route_selection_expression(Option<String>)
: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.
tags(Option<HashMap::<String, String>>)
:A collection of tags associated with the API.
version(Option<String>)
:A version identifier for the API.
warnings(Option<Vec::<String>>)
:The warning messages reported when failonwarnings is turned on during API import.
- On failure, responds with
SdkError<GetApiError>
source§impl Client
impl Client
sourcepub fn get_api_mapping(&self) -> GetApiMappingFluentBuilder
pub fn get_api_mapping(&self) -> GetApiMappingFluentBuilder
Constructs a fluent builder for the GetApiMapping
operation.
- The fluent builder is configurable:
api_mapping_id(impl Into<String>)
/set_api_mapping_id(Option<String>)
:
required: trueThe API mapping identifier.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name.
- On success, responds with
GetApiMappingOutput
with field(s):api_id(Option<String>)
:The API identifier.
api_mapping_id(Option<String>)
:The API mapping identifier.
api_mapping_key(Option<String>)
:The API mapping key.
stage(Option<String>)
:The API stage.
- On failure, responds with
SdkError<GetApiMappingError>
source§impl Client
impl Client
sourcepub fn get_api_mappings(&self) -> GetApiMappingsFluentBuilder
pub fn get_api_mappings(&self) -> GetApiMappingsFluentBuilder
Constructs a fluent builder for the GetApiMappings
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name.
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: falseThe maximum number of elements to be returned for this resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe next page of elements from this collection. Not valid for the last element of the collection.
- On success, responds with
GetApiMappingsOutput
with field(s):items(Option<Vec::<ApiMapping>>)
:The elements from this collection.
next_token(Option<String>)
:The next page of elements from this collection. Not valid for the last element of the collection.
- On failure, responds with
SdkError<GetApiMappingsError>
source§impl Client
impl Client
sourcepub fn get_apis(&self) -> GetApisFluentBuilder
pub fn get_apis(&self) -> GetApisFluentBuilder
Constructs a fluent builder for the GetApis
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: falseThe maximum number of elements to be returned for this resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe next page of elements from this collection. Not valid for the last element of the collection.
- On success, responds with
GetApisOutput
with field(s):items(Option<Vec::<Api>>)
:The elements from this collection.
next_token(Option<String>)
:The next page of elements from this collection. Not valid for the last element of the collection.
- On failure, responds with
SdkError<GetApisError>
source§impl Client
impl Client
Constructs a fluent builder for the GetAuthorizer
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
authorizer_id(impl Into<String>)
/set_authorizer_id(Option<String>)
:
required: trueThe authorizer identifier.
- On success, responds with
GetAuthorizerOutput
with field(s):authorizer_credentials_arn(Option<String>)
:Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don’t specify this parameter. Supported only for REQUEST authorizers.
authorizer_id(Option<String>)
:The authorizer identifier.
authorizer_payload_format_version(Option<String>)
: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.
authorizer_result_ttl_in_seconds(Option<i32>)
: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.
authorizer_type(Option<AuthorizerType>)
: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).
authorizer_uri(Option<String>)
: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. enable_simple_responses(Option<bool>)
:Specifies whether a Lambda authorizer returns a response in a simple format. 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
identity_source(Option<Vec::<String>>)
: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. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
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.
identity_validation_expression(Option<String>)
:The validation expression does not apply to the REQUEST authorizer.
jwt_configuration(Option<JwtConfiguration>)
:Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
name(Option<String>)
:The name of the authorizer.
- On failure, responds with
SdkError<GetAuthorizerError>
source§impl Client
impl Client
Constructs a fluent builder for the GetAuthorizers
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: falseThe maximum number of elements to be returned for this resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe next page of elements from this collection. Not valid for the last element of the collection.
- On success, responds with
GetAuthorizersOutput
with field(s):items(Option<Vec::<Authorizer>>)
:The elements from this collection.
next_token(Option<String>)
:The next page of elements from this collection. Not valid for the last element of the collection.
- On failure, responds with
SdkError<GetAuthorizersError>
source§impl Client
impl Client
sourcepub fn get_deployment(&self) -> GetDeploymentFluentBuilder
pub fn get_deployment(&self) -> GetDeploymentFluentBuilder
Constructs a fluent builder for the GetDeployment
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe deployment ID.
- On success, responds with
GetDeploymentOutput
with field(s):auto_deployed(Option<bool>)
:Specifies whether a deployment was automatically released.
created_date(Option<DateTime>)
:The date and time when the Deployment resource was created.
deployment_id(Option<String>)
:The identifier for the deployment.
deployment_status(Option<DeploymentStatus>)
:The status of the deployment: PENDING, FAILED, or SUCCEEDED.
deployment_status_message(Option<String>)
:May contain additional feedback on the status of an API deployment.
description(Option<String>)
:The description for the deployment.
- On failure, responds with
SdkError<GetDeploymentError>
source§impl Client
impl Client
sourcepub fn get_deployments(&self) -> GetDeploymentsFluentBuilder
pub fn get_deployments(&self) -> GetDeploymentsFluentBuilder
Constructs a fluent builder for the GetDeployments
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: falseThe maximum number of elements to be returned for this resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe next page of elements from this collection. Not valid for the last element of the collection.
- On success, responds with
GetDeploymentsOutput
with field(s):items(Option<Vec::<Deployment>>)
:The elements from this collection.
next_token(Option<String>)
:The next page of elements from this collection. Not valid for the last element of the collection.
- On failure, responds with
SdkError<GetDeploymentsError>
source§impl Client
impl Client
sourcepub fn get_domain_name(&self) -> GetDomainNameFluentBuilder
pub fn get_domain_name(&self) -> GetDomainNameFluentBuilder
Constructs a fluent builder for the GetDomainName
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name.
- On success, responds with
GetDomainNameOutput
with field(s):api_mapping_selection_expression(Option<String>)
:The API mapping selection expression.
domain_name(Option<String>)
:The name of the DomainName resource.
domain_name_configurations(Option<Vec::<DomainNameConfiguration>>)
:The domain name configurations.
mutual_tls_authentication(Option<MutualTlsAuthentication>)
:The mutual TLS authentication configuration for a custom domain name.
tags(Option<HashMap::<String, String>>)
:The collection of tags associated with a domain name.
- On failure, responds with
SdkError<GetDomainNameError>
source§impl Client
impl Client
sourcepub fn get_domain_names(&self) -> GetDomainNamesFluentBuilder
pub fn get_domain_names(&self) -> GetDomainNamesFluentBuilder
Constructs a fluent builder for the GetDomainNames
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: falseThe maximum number of elements to be returned for this resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe next page of elements from this collection. Not valid for the last element of the collection.
- On success, responds with
GetDomainNamesOutput
with field(s):items(Option<Vec::<DomainName>>)
:The elements from this collection.
next_token(Option<String>)
:The next page of elements from this collection. Not valid for the last element of the collection.
- On failure, responds with
SdkError<GetDomainNamesError>
source§impl Client
impl Client
sourcepub fn get_integration(&self) -> GetIntegrationFluentBuilder
pub fn get_integration(&self) -> GetIntegrationFluentBuilder
Constructs a fluent builder for the GetIntegration
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
integration_id(impl Into<String>)
/set_integration_id(Option<String>)
:
required: trueThe integration ID.
- On success, responds with
GetIntegrationOutput
with field(s):api_gateway_managed(Option<bool>)
:Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can’t delete it.
connection_id(Option<String>)
:The ID of the VPC link for a private integration. Supported only for HTTP APIs.
connection_type(Option<ConnectionType>)
: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.
content_handling_strategy(Option<ContentHandlingStrategy>)
: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.
credentials_arn(Option<String>)
:Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To require that the caller’s identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null.
description(Option<String>)
:Represents the description of an integration.
integration_id(Option<String>)
:Represents the identifier of an integration.
integration_method(Option<String>)
:Specifies the integration’s HTTP method type.
integration_response_selection_expression(Option<String>)
:The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
integration_subtype(Option<String>)
:Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
integration_type(Option<IntegrationType>)
: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.
MOCK: for integrating the route or method request with API Gateway as a “loopback” endpoint without invoking any backend. Supported only for WebSocket APIs.
integration_uri(Option<String>)
: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.
passthrough_behavior(Option<PassthroughBehavior>)
:Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. 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.
payload_format_version(Option<String>)
:Specifies the format of the payload sent to an integration. Required for HTTP APIs.
request_parameters(Option<HashMap::<String, String>>)
: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 backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The 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.
request_templates(Option<HashMap::<String, String>>)
: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.
response_parameters(Option<HashMap::<String, HashMap::<String, String>>>)
: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.
template_selection_expression(Option<String>)
:The template selection expression for the integration. Supported only for WebSocket APIs.
timeout_in_millis(Option<i32>)
: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.
tls_config(Option<TlsConfig>)
: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.
- On failure, responds with
SdkError<GetIntegrationError>
source§impl Client
impl Client
sourcepub fn get_integration_response(&self) -> GetIntegrationResponseFluentBuilder
pub fn get_integration_response(&self) -> GetIntegrationResponseFluentBuilder
Constructs a fluent builder for the GetIntegrationResponse
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
integration_id(impl Into<String>)
/set_integration_id(Option<String>)
:
required: trueThe integration ID.
integration_response_id(impl Into<String>)
/set_integration_response_id(Option<String>)
:
required: trueThe integration response ID.
- On success, responds with
GetIntegrationResponseOutput
with field(s):content_handling_strategy(Option<ContentHandlingStrategy>)
: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.
integration_response_id(Option<String>)
:The integration response ID.
integration_response_key(Option<String>)
:The integration response key.
response_parameters(Option<HashMap::<String, String>>)
: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.
response_templates(Option<HashMap::<String, String>>)
: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.
template_selection_expression(Option<String>)
:The template selection expressions for the integration response.
- On failure, responds with
SdkError<GetIntegrationResponseError>
source§impl Client
impl Client
sourcepub fn get_integration_responses(&self) -> GetIntegrationResponsesFluentBuilder
pub fn get_integration_responses(&self) -> GetIntegrationResponsesFluentBuilder
Constructs a fluent builder for the GetIntegrationResponses
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
integration_id(impl Into<String>)
/set_integration_id(Option<String>)
:
required: trueThe integration ID.
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: falseThe maximum number of elements to be returned for this resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe next page of elements from this collection. Not valid for the last element of the collection.
- On success, responds with
GetIntegrationResponsesOutput
with field(s):items(Option<Vec::<IntegrationResponse>>)
:The elements from this collection.
next_token(Option<String>)
:The next page of elements from this collection. Not valid for the last element of the collection.
- On failure, responds with
SdkError<GetIntegrationResponsesError>
source§impl Client
impl Client
sourcepub fn get_integrations(&self) -> GetIntegrationsFluentBuilder
pub fn get_integrations(&self) -> GetIntegrationsFluentBuilder
Constructs a fluent builder for the GetIntegrations
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: falseThe maximum number of elements to be returned for this resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe next page of elements from this collection. Not valid for the last element of the collection.
- On success, responds with
GetIntegrationsOutput
with field(s):items(Option<Vec::<Integration>>)
:The elements from this collection.
next_token(Option<String>)
:The next page of elements from this collection. Not valid for the last element of the collection.
- On failure, responds with
SdkError<GetIntegrationsError>
source§impl Client
impl Client
sourcepub fn get_model(&self) -> GetModelFluentBuilder
pub fn get_model(&self) -> GetModelFluentBuilder
Constructs a fluent builder for the GetModel
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
model_id(impl Into<String>)
/set_model_id(Option<String>)
:
required: trueThe model ID.
- On success, responds with
GetModelOutput
with field(s):content_type(Option<String>)
:The content-type for the model, for example, “application/json”.
description(Option<String>)
:The description of the model.
model_id(Option<String>)
:The model identifier.
name(Option<String>)
:The name of the model. Must be alphanumeric.
schema(Option<String>)
:The schema for the model. For application/json models, this should be JSON schema draft 4 model.
- On failure, responds with
SdkError<GetModelError>
source§impl Client
impl Client
sourcepub fn get_model_template(&self) -> GetModelTemplateFluentBuilder
pub fn get_model_template(&self) -> GetModelTemplateFluentBuilder
Constructs a fluent builder for the GetModelTemplate
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
model_id(impl Into<String>)
/set_model_id(Option<String>)
:
required: trueThe model ID.
- On success, responds with
GetModelTemplateOutput
with field(s):value(Option<String>)
:The template value.
- On failure, responds with
SdkError<GetModelTemplateError>
source§impl Client
impl Client
sourcepub fn get_models(&self) -> GetModelsFluentBuilder
pub fn get_models(&self) -> GetModelsFluentBuilder
Constructs a fluent builder for the GetModels
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: falseThe maximum number of elements to be returned for this resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe next page of elements from this collection. Not valid for the last element of the collection.
- On success, responds with
GetModelsOutput
with field(s):items(Option<Vec::<Model>>)
:The elements from this collection.
next_token(Option<String>)
:The next page of elements from this collection. Not valid for the last element of the collection.
- On failure, responds with
SdkError<GetModelsError>
source§impl Client
impl Client
sourcepub fn get_route(&self) -> GetRouteFluentBuilder
pub fn get_route(&self) -> GetRouteFluentBuilder
Constructs a fluent builder for the GetRoute
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
route_id(impl Into<String>)
/set_route_id(Option<String>)
:
required: trueThe route ID.
- On success, responds with
GetRouteOutput
with field(s):api_gateway_managed(Option<bool>)
:Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can’t modify the $default route key.
api_key_required(Option<bool>)
:Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
authorization_scopes(Option<Vec::<String>>)
:A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
authorization_type(Option<AuthorizationType>)
: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.
authorizer_id(Option<String>)
: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.
model_selection_expression(Option<String>)
:The model selection expression for the route. Supported only for WebSocket APIs.
operation_name(Option<String>)
:The operation name for the route.
request_models(Option<HashMap::<String, String>>)
:The request models for the route. Supported only for WebSocket APIs.
request_parameters(Option<HashMap::<String, ParameterConstraints>>)
:The request parameters for the route. Supported only for WebSocket APIs.
route_id(Option<String>)
:The route ID.
route_key(Option<String>)
:The route key for the route.
route_response_selection_expression(Option<String>)
:The route response selection expression for the route. Supported only for WebSocket APIs.
target(Option<String>)
:The target for the route.
- On failure, responds with
SdkError<GetRouteError>
source§impl Client
impl Client
sourcepub fn get_route_response(&self) -> GetRouteResponseFluentBuilder
pub fn get_route_response(&self) -> GetRouteResponseFluentBuilder
Constructs a fluent builder for the GetRouteResponse
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
route_id(impl Into<String>)
/set_route_id(Option<String>)
:
required: trueThe route ID.
route_response_id(impl Into<String>)
/set_route_response_id(Option<String>)
:
required: trueThe route response ID.
- On success, responds with
GetRouteResponseOutput
with field(s):model_selection_expression(Option<String>)
:Represents the model selection expression of a route response. Supported only for WebSocket APIs.
response_models(Option<HashMap::<String, String>>)
:Represents the response models of a route response.
response_parameters(Option<HashMap::<String, ParameterConstraints>>)
:Represents the response parameters of a route response.
route_response_id(Option<String>)
:Represents the identifier of a route response.
route_response_key(Option<String>)
:Represents the route response key of a route response.
- On failure, responds with
SdkError<GetRouteResponseError>
source§impl Client
impl Client
sourcepub fn get_route_responses(&self) -> GetRouteResponsesFluentBuilder
pub fn get_route_responses(&self) -> GetRouteResponsesFluentBuilder
Constructs a fluent builder for the GetRouteResponses
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: falseThe maximum number of elements to be returned for this resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe next page of elements from this collection. Not valid for the last element of the collection.
route_id(impl Into<String>)
/set_route_id(Option<String>)
:
required: trueThe route ID.
- On success, responds with
GetRouteResponsesOutput
with field(s):items(Option<Vec::<RouteResponse>>)
:The elements from this collection.
next_token(Option<String>)
:The next page of elements from this collection. Not valid for the last element of the collection.
- On failure, responds with
SdkError<GetRouteResponsesError>
source§impl Client
impl Client
sourcepub fn get_routes(&self) -> GetRoutesFluentBuilder
pub fn get_routes(&self) -> GetRoutesFluentBuilder
Constructs a fluent builder for the GetRoutes
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: falseThe maximum number of elements to be returned for this resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe next page of elements from this collection. Not valid for the last element of the collection.
- On success, responds with
GetRoutesOutput
with field(s):items(Option<Vec::<Route>>)
:The elements from this collection.
next_token(Option<String>)
:The next page of elements from this collection. Not valid for the last element of the collection.
- On failure, responds with
SdkError<GetRoutesError>
source§impl Client
impl Client
sourcepub fn get_stage(&self) -> GetStageFluentBuilder
pub fn get_stage(&self) -> GetStageFluentBuilder
Constructs a fluent builder for the GetStage
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
- On success, responds with
GetStageOutput
with field(s):access_log_settings(Option<AccessLogSettings>)
:Settings for logging access in this stage.
api_gateway_managed(Option<bool>)
:Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can’t modify the $default stage.
auto_deploy(Option<bool>)
:Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
client_certificate_id(Option<String>)
:The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
created_date(Option<DateTime>)
:The timestamp when the stage was created.
default_route_settings(Option<RouteSettings>)
:Default route settings for the stage.
deployment_id(Option<String>)
:The identifier of the Deployment that the Stage is associated with. Can’t be updated if autoDeploy is enabled.
description(Option<String>)
:The description of the stage.
last_deployment_status_message(Option<String>)
:Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
last_updated_date(Option<DateTime>)
:The timestamp when the stage was last updated.
route_settings(Option<HashMap::<String, RouteSettings>>)
:Route settings for the stage, by routeKey.
stage_name(Option<String>)
:The name of the stage.
stage_variables(Option<HashMap::<String, String>>)
:A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<GetStageError>
source§impl Client
impl Client
sourcepub fn get_stages(&self) -> GetStagesFluentBuilder
pub fn get_stages(&self) -> GetStagesFluentBuilder
Constructs a fluent builder for the GetStages
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: falseThe maximum number of elements to be returned for this resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe next page of elements from this collection. Not valid for the last element of the collection.
- On success, responds with
GetStagesOutput
with field(s):items(Option<Vec::<Stage>>)
:The elements from this collection.
next_token(Option<String>)
:The next page of elements from this collection. Not valid for the last element of the collection.
- On failure, responds with
SdkError<GetStagesError>
source§impl Client
impl Client
Constructs a fluent builder for the GetTags
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe resource ARN for the tag.
- On success, responds with
GetTagsOutput
with field(s):tags(Option<HashMap::<String, String>>)
:Represents a collection of tags associated with the resource.
- On failure, responds with
SdkError<GetTagsError>
source§impl Client
impl Client
sourcepub fn get_vpc_link(&self) -> GetVpcLinkFluentBuilder
pub fn get_vpc_link(&self) -> GetVpcLinkFluentBuilder
Constructs a fluent builder for the GetVpcLink
operation.
- The fluent builder is configurable:
vpc_link_id(impl Into<String>)
/set_vpc_link_id(Option<String>)
:
required: trueThe ID of the VPC link.
- On success, responds with
GetVpcLinkOutput
with field(s):created_date(Option<DateTime>)
:The timestamp when the VPC link was created.
name(Option<String>)
:The name of the VPC link.
security_group_ids(Option<Vec::<String>>)
:A list of security group IDs for the VPC link.
subnet_ids(Option<Vec::<String>>)
:A list of subnet IDs to include in the VPC link.
tags(Option<HashMap::<String, String>>)
:Tags for the VPC link.
vpc_link_id(Option<String>)
:The ID of the VPC link.
vpc_link_status(Option<VpcLinkStatus>)
:The status of the VPC link.
vpc_link_status_message(Option<String>)
:A message summarizing the cause of the status of the VPC link.
vpc_link_version(Option<VpcLinkVersion>)
:The version of the VPC link.
- On failure, responds with
SdkError<GetVpcLinkError>
source§impl Client
impl Client
sourcepub fn get_vpc_links(&self) -> GetVpcLinksFluentBuilder
pub fn get_vpc_links(&self) -> GetVpcLinksFluentBuilder
Constructs a fluent builder for the GetVpcLinks
operation.
- The fluent builder is configurable:
max_results(impl Into<String>)
/set_max_results(Option<String>)
:
required: falseThe maximum number of elements to be returned for this resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe next page of elements from this collection. Not valid for the last element of the collection.
- On success, responds with
GetVpcLinksOutput
with field(s):items(Option<Vec::<VpcLink>>)
:A collection of VPC links.
next_token(Option<String>)
:The next page of elements from this collection. Not valid for the last element of the collection.
- On failure, responds with
SdkError<GetVpcLinksError>
source§impl Client
impl Client
sourcepub fn import_api(&self) -> ImportApiFluentBuilder
pub fn import_api(&self) -> ImportApiFluentBuilder
Constructs a fluent builder for the ImportApi
operation.
- The fluent builder is configurable:
basepath(impl Into<String>)
/set_basepath(Option<String>)
:
required: falseSpecifies 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.
body(impl Into<String>)
/set_body(Option<String>)
:
required: trueThe OpenAPI definition. Supported only for HTTP APIs.
fail_on_warnings(bool)
/set_fail_on_warnings(Option<bool>)
:
required: falseSpecifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
- On success, responds with
ImportApiOutput
with field(s):api_endpoint(Option<String>)
:The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
api_gateway_managed(Option<bool>)
:Specifies whether an API is managed by API Gateway. You can’t update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
api_id(Option<String>)
:The API ID.
api_key_selection_expression(Option<String>)
:An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
cors_configuration(Option<Cors>)
:A CORS configuration. Supported only for HTTP APIs.
created_date(Option<DateTime>)
:The timestamp when the API was created.
description(Option<String>)
:The description of the API.
disable_schema_validation(Option<bool>)
:Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
disable_execute_api_endpoint(Option<bool>)
: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.
import_info(Option<Vec::<String>>)
:The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
name(Option<String>)
:The name of the API.
protocol_type(Option<ProtocolType>)
:The API protocol.
route_selection_expression(Option<String>)
: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.
tags(Option<HashMap::<String, String>>)
:A collection of tags associated with the API.
version(Option<String>)
:A version identifier for the API.
warnings(Option<Vec::<String>>)
:The warning messages reported when failonwarnings is turned on during API import.
- On failure, responds with
SdkError<ImportApiError>
source§impl Client
impl Client
sourcepub fn reimport_api(&self) -> ReimportApiFluentBuilder
pub fn reimport_api(&self) -> ReimportApiFluentBuilder
Constructs a fluent builder for the ReimportApi
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
basepath(impl Into<String>)
/set_basepath(Option<String>)
:
required: falseSpecifies 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.
body(impl Into<String>)
/set_body(Option<String>)
:
required: trueThe OpenAPI definition. Supported only for HTTP APIs.
fail_on_warnings(bool)
/set_fail_on_warnings(Option<bool>)
:
required: falseSpecifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
- On success, responds with
ReimportApiOutput
with field(s):api_endpoint(Option<String>)
:The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
api_gateway_managed(Option<bool>)
:Specifies whether an API is managed by API Gateway. You can’t update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
api_id(Option<String>)
:The API ID.
api_key_selection_expression(Option<String>)
:An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
cors_configuration(Option<Cors>)
:A CORS configuration. Supported only for HTTP APIs.
created_date(Option<DateTime>)
:The timestamp when the API was created.
description(Option<String>)
:The description of the API.
disable_schema_validation(Option<bool>)
:Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
disable_execute_api_endpoint(Option<bool>)
: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.
import_info(Option<Vec::<String>>)
:The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
name(Option<String>)
:The name of the API.
protocol_type(Option<ProtocolType>)
:The API protocol.
route_selection_expression(Option<String>)
: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.
tags(Option<HashMap::<String, String>>)
:A collection of tags associated with the API.
version(Option<String>)
:A version identifier for the API.
warnings(Option<Vec::<String>>)
:The warning messages reported when failonwarnings is turned on during API import.
- On failure, responds with
SdkError<ReimportApiError>
source§impl Client
impl Client
Constructs a fluent builder for the ResetAuthorizersCache
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
- On success, responds with
ResetAuthorizersCacheOutput
- On failure, responds with
SdkError<ResetAuthorizersCacheError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe resource ARN for the tag.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe collection of tags. Each tag element is associated with a given resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe resource ARN for the tag.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe Tag keys to delete
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_api(&self) -> UpdateApiFluentBuilder
pub fn update_api(&self) -> UpdateApiFluentBuilder
Constructs a fluent builder for the UpdateApi
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
api_key_selection_expression(impl Into<String>)
/set_api_key_selection_expression(Option<String>)
:
required: falseAn API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
cors_configuration(Cors)
/set_cors_configuration(Option<Cors>)
:
required: falseA CORS configuration. Supported only for HTTP APIs.
credentials_arn(impl Into<String>)
/set_credentials_arn(Option<String>)
:
required: falseThis 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, don’t specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the API.
disable_schema_validation(bool)
/set_disable_schema_validation(Option<bool>)
:
required: falseAvoid validating models when creating a deployment. Supported only for WebSocket APIs.
disable_execute_api_endpoint(bool)
/set_disable_execute_api_endpoint(Option<bool>)
:
required: falseSpecifies 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.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the API.
route_key(impl Into<String>)
/set_route_key(Option<String>)
:
required: falseThis property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
route_selection_expression(impl Into<String>)
/set_route_selection_expression(Option<String>)
:
required: falseThe 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.
target(impl Into<String>)
/set_target(Option<String>)
:
required: falseThis property is part of quick create. 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. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can’t remove it from an API. Supported only for HTTP APIs.
version(impl Into<String>)
/set_version(Option<String>)
:
required: falseA version identifier for the API.
- On success, responds with
UpdateApiOutput
with field(s):api_endpoint(Option<String>)
:The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
api_gateway_managed(Option<bool>)
:Specifies whether an API is managed by API Gateway. You can’t update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
api_id(Option<String>)
:The API ID.
api_key_selection_expression(Option<String>)
:An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
cors_configuration(Option<Cors>)
:A CORS configuration. Supported only for HTTP APIs.
created_date(Option<DateTime>)
:The timestamp when the API was created.
description(Option<String>)
:The description of the API.
disable_schema_validation(Option<bool>)
:Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
disable_execute_api_endpoint(Option<bool>)
: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.
import_info(Option<Vec::<String>>)
:The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
name(Option<String>)
:The name of the API.
protocol_type(Option<ProtocolType>)
:The API protocol.
route_selection_expression(Option<String>)
: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.
tags(Option<HashMap::<String, String>>)
:A collection of tags associated with the API.
version(Option<String>)
:A version identifier for the API.
warnings(Option<Vec::<String>>)
:The warning messages reported when failonwarnings is turned on during API import.
- On failure, responds with
SdkError<UpdateApiError>
source§impl Client
impl Client
sourcepub fn update_api_mapping(&self) -> UpdateApiMappingFluentBuilder
pub fn update_api_mapping(&self) -> UpdateApiMappingFluentBuilder
Constructs a fluent builder for the UpdateApiMapping
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
api_mapping_id(impl Into<String>)
/set_api_mapping_id(Option<String>)
:
required: trueThe API mapping identifier.
api_mapping_key(impl Into<String>)
/set_api_mapping_key(Option<String>)
:
required: falseThe API mapping key.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name.
stage(impl Into<String>)
/set_stage(Option<String>)
:
required: falseThe API stage.
- On success, responds with
UpdateApiMappingOutput
with field(s):api_id(Option<String>)
:The API identifier.
api_mapping_id(Option<String>)
:The API mapping identifier.
api_mapping_key(Option<String>)
:The API mapping key.
stage(Option<String>)
:The API stage.
- On failure, responds with
SdkError<UpdateApiMappingError>
source§impl Client
impl Client
Constructs a fluent builder for the UpdateAuthorizer
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
authorizer_credentials_arn(impl Into<String>)
/set_authorizer_credentials_arn(Option<String>)
:
required: falseSpecifies 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.
authorizer_id(impl Into<String>)
/set_authorizer_id(Option<String>)
:
required: trueThe authorizer identifier.
authorizer_payload_format_version(impl Into<String>)
/set_authorizer_payload_format_version(Option<String>)
:
required: falseSpecifies 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.
authorizer_result_ttl_in_seconds(i32)
/set_authorizer_result_ttl_in_seconds(Option<i32>)
:
required: falseThe 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.
authorizer_type(AuthorizerType)
/set_authorizer_type(Option<AuthorizerType>)
:
required: falseThe authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
authorizer_uri(impl Into<String>)
/set_authorizer_uri(Option<String>)
:
required: falseThe 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. enable_simple_responses(bool)
/set_enable_simple_responses(Option<bool>)
:
required: falseSpecifies 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
identity_source(impl Into<String>)
/set_identity_source(Option<Vec::<String>>)
:
required: falseThe 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. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
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.
identity_validation_expression(impl Into<String>)
/set_identity_validation_expression(Option<String>)
:
required: falseThis parameter is not used.
jwt_configuration(JwtConfiguration)
/set_jwt_configuration(Option<JwtConfiguration>)
:
required: falseRepresents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the authorizer.
- On success, responds with
UpdateAuthorizerOutput
with field(s):authorizer_credentials_arn(Option<String>)
:Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don’t specify this parameter. Supported only for REQUEST authorizers.
authorizer_id(Option<String>)
:The authorizer identifier.
authorizer_payload_format_version(Option<String>)
: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.
authorizer_result_ttl_in_seconds(Option<i32>)
: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.
authorizer_type(Option<AuthorizerType>)
: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).
authorizer_uri(Option<String>)
: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. enable_simple_responses(Option<bool>)
:Specifies whether a Lambda authorizer returns a response in a simple format. 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
identity_source(Option<Vec::<String>>)
: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. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
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.
identity_validation_expression(Option<String>)
:The validation expression does not apply to the REQUEST authorizer.
jwt_configuration(Option<JwtConfiguration>)
:Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
name(Option<String>)
:The name of the authorizer.
- On failure, responds with
SdkError<UpdateAuthorizerError>
source§impl Client
impl Client
sourcepub fn update_deployment(&self) -> UpdateDeploymentFluentBuilder
pub fn update_deployment(&self) -> UpdateDeploymentFluentBuilder
Constructs a fluent builder for the UpdateDeployment
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe deployment ID.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description for the deployment resource.
- On success, responds with
UpdateDeploymentOutput
with field(s):auto_deployed(Option<bool>)
:Specifies whether a deployment was automatically released.
created_date(Option<DateTime>)
:The date and time when the Deployment resource was created.
deployment_id(Option<String>)
:The identifier for the deployment.
deployment_status(Option<DeploymentStatus>)
:The status of the deployment: PENDING, FAILED, or SUCCEEDED.
deployment_status_message(Option<String>)
:May contain additional feedback on the status of an API deployment.
description(Option<String>)
:The description for the deployment.
- On failure, responds with
SdkError<UpdateDeploymentError>
source§impl Client
impl Client
sourcepub fn update_domain_name(&self) -> UpdateDomainNameFluentBuilder
pub fn update_domain_name(&self) -> UpdateDomainNameFluentBuilder
Constructs a fluent builder for the UpdateDomainName
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name.
domain_name_configurations(DomainNameConfiguration)
/set_domain_name_configurations(Option<Vec::<DomainNameConfiguration>>)
:
required: falseThe domain name configurations.
mutual_tls_authentication(MutualTlsAuthenticationInput)
/set_mutual_tls_authentication(Option<MutualTlsAuthenticationInput>)
:
required: falseThe mutual TLS authentication configuration for a custom domain name.
- On success, responds with
UpdateDomainNameOutput
with field(s):api_mapping_selection_expression(Option<String>)
:The API mapping selection expression.
domain_name(Option<String>)
:The name of the DomainName resource.
domain_name_configurations(Option<Vec::<DomainNameConfiguration>>)
:The domain name configurations.
mutual_tls_authentication(Option<MutualTlsAuthentication>)
:The mutual TLS authentication configuration for a custom domain name.
tags(Option<HashMap::<String, String>>)
:The collection of tags associated with a domain name.
- On failure, responds with
SdkError<UpdateDomainNameError>
source§impl Client
impl Client
sourcepub fn update_integration(&self) -> UpdateIntegrationFluentBuilder
pub fn update_integration(&self) -> UpdateIntegrationFluentBuilder
Constructs a fluent builder for the UpdateIntegration
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
connection_id(impl Into<String>)
/set_connection_id(Option<String>)
:
required: falseThe ID of the VPC link for a private integration. Supported only for HTTP APIs.
connection_type(ConnectionType)
/set_connection_type(Option<ConnectionType>)
:
required: falseThe 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.
content_handling_strategy(ContentHandlingStrategy)
/set_content_handling_strategy(Option<ContentHandlingStrategy>)
:
required: falseSupported 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.
credentials_arn(impl Into<String>)
/set_credentials_arn(Option<String>)
:
required: falseSpecifies 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.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the integration
integration_id(impl Into<String>)
/set_integration_id(Option<String>)
:
required: trueThe integration ID.
integration_method(impl Into<String>)
/set_integration_method(Option<String>)
:
required: falseSpecifies the integration’s HTTP method type.
integration_subtype(impl Into<String>)
/set_integration_subtype(Option<String>)
:
required: falseSupported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
integration_type(IntegrationType)
/set_integration_type(Option<IntegrationType>)
:
required: falseThe 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.
integration_uri(impl Into<String>)
/set_integration_uri(Option<String>)
:
required: falseFor 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.
passthrough_behavior(PassthroughBehavior)
/set_passthrough_behavior(Option<PassthroughBehavior>)
:
required: falseSpecifies 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.
payload_format_version(impl Into<String>)
/set_payload_format_version(Option<String>)
:
required: falseSpecifies the format of the payload sent to an integration. Required for HTTP APIs.
request_parameters(impl Into<String>, impl Into<String>)
/set_request_parameters(Option<HashMap::<String, String>>)
:
required: falseFor 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.
request_templates(impl Into<String>, impl Into<String>)
/set_request_templates(Option<HashMap::<String, String>>)
:
required: falseRepresents 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.
response_parameters(impl Into<String>, HashMap::<String, String>)
/set_response_parameters(Option<HashMap::<String, HashMap::<String, String>>>)
:
required: falseSupported 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.
template_selection_expression(impl Into<String>)
/set_template_selection_expression(Option<String>)
:
required: falseThe template selection expression for the integration.
timeout_in_millis(i32)
/set_timeout_in_millis(Option<i32>)
:
required: falseCustom 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.
tls_config(TlsConfigInput)
/set_tls_config(Option<TlsConfigInput>)
:
required: falseThe TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
- On success, responds with
UpdateIntegrationOutput
with field(s):api_gateway_managed(Option<bool>)
:Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can’t delete it.
connection_id(Option<String>)
:The ID of the VPC link for a private integration. Supported only for HTTP APIs.
connection_type(Option<ConnectionType>)
: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.
content_handling_strategy(Option<ContentHandlingStrategy>)
: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.
credentials_arn(Option<String>)
:Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To require that the caller’s identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null.
description(Option<String>)
:Represents the description of an integration.
integration_id(Option<String>)
:Represents the identifier of an integration.
integration_method(Option<String>)
:Specifies the integration’s HTTP method type.
integration_response_selection_expression(Option<String>)
:The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
integration_subtype(Option<String>)
:Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
integration_type(Option<IntegrationType>)
: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.
MOCK: for integrating the route or method request with API Gateway as a “loopback” endpoint without invoking any backend. Supported only for WebSocket APIs.
integration_uri(Option<String>)
: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.
passthrough_behavior(Option<PassthroughBehavior>)
:Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. 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.
payload_format_version(Option<String>)
:Specifies the format of the payload sent to an integration. Required for HTTP APIs.
request_parameters(Option<HashMap::<String, String>>)
: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 backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The 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.
request_templates(Option<HashMap::<String, String>>)
: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.
response_parameters(Option<HashMap::<String, HashMap::<String, String>>>)
: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.
template_selection_expression(Option<String>)
:The template selection expression for the integration. Supported only for WebSocket APIs.
timeout_in_millis(Option<i32>)
: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.
tls_config(Option<TlsConfig>)
: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.
- On failure, responds with
SdkError<UpdateIntegrationError>
source§impl Client
impl Client
sourcepub fn update_integration_response(
&self
) -> UpdateIntegrationResponseFluentBuilder
pub fn update_integration_response( &self ) -> UpdateIntegrationResponseFluentBuilder
Constructs a fluent builder for the UpdateIntegrationResponse
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
content_handling_strategy(ContentHandlingStrategy)
/set_content_handling_strategy(Option<ContentHandlingStrategy>)
:
required: falseSupported 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.
integration_id(impl Into<String>)
/set_integration_id(Option<String>)
:
required: trueThe integration ID.
integration_response_id(impl Into<String>)
/set_integration_response_id(Option<String>)
:
required: trueThe integration response ID.
integration_response_key(impl Into<String>)
/set_integration_response_key(Option<String>)
:
required: falseThe integration response key.
response_parameters(impl Into<String>, impl Into<String>)
/set_response_parameters(Option<HashMap::<String, String>>)
:
required: falseA 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.response_templates(impl Into<String>, impl Into<String>)
/set_response_templates(Option<HashMap::<String, String>>)
:
required: falseThe 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.
template_selection_expression(impl Into<String>)
/set_template_selection_expression(Option<String>)
:
required: falseThe template selection expression for the integration response. Supported only for WebSocket APIs.
- On success, responds with
UpdateIntegrationResponseOutput
with field(s):content_handling_strategy(Option<ContentHandlingStrategy>)
: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.
integration_response_id(Option<String>)
:The integration response ID.
integration_response_key(Option<String>)
:The integration response key.
response_parameters(Option<HashMap::<String, String>>)
: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.
response_templates(Option<HashMap::<String, String>>)
: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.
template_selection_expression(Option<String>)
:The template selection expressions for the integration response.
- On failure, responds with
SdkError<UpdateIntegrationResponseError>
source§impl Client
impl Client
sourcepub fn update_model(&self) -> UpdateModelFluentBuilder
pub fn update_model(&self) -> UpdateModelFluentBuilder
Constructs a fluent builder for the UpdateModel
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
content_type(impl Into<String>)
/set_content_type(Option<String>)
:
required: falseThe content-type for the model, for example, “application/json”.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the model.
model_id(impl Into<String>)
/set_model_id(Option<String>)
:
required: trueThe model ID.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the model.
schema(impl Into<String>)
/set_schema(Option<String>)
:
required: falseThe schema for the model. For application/json models, this should be JSON schema draft 4 model.
- On success, responds with
UpdateModelOutput
with field(s):content_type(Option<String>)
:The content-type for the model, for example, “application/json”.
description(Option<String>)
:The description of the model.
model_id(Option<String>)
:The model identifier.
name(Option<String>)
:The name of the model. Must be alphanumeric.
schema(Option<String>)
:The schema for the model. For application/json models, this should be JSON schema draft 4 model.
- On failure, responds with
SdkError<UpdateModelError>
source§impl Client
impl Client
sourcepub fn update_route(&self) -> UpdateRouteFluentBuilder
pub fn update_route(&self) -> UpdateRouteFluentBuilder
Constructs a fluent builder for the UpdateRoute
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
api_key_required(bool)
/set_api_key_required(Option<bool>)
:
required: falseSpecifies whether an API key is required for the route. Supported only for WebSocket APIs.
authorization_scopes(impl Into<String>)
/set_authorization_scopes(Option<Vec::<String>>)
:
required: falseThe authorization scopes supported by this route.
authorization_type(AuthorizationType)
/set_authorization_type(Option<AuthorizationType>)
:
required: falseThe 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.
authorizer_id(impl Into<String>)
/set_authorizer_id(Option<String>)
:
required: falseThe identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
model_selection_expression(impl Into<String>)
/set_model_selection_expression(Option<String>)
:
required: falseThe model selection expression for the route. Supported only for WebSocket APIs.
operation_name(impl Into<String>)
/set_operation_name(Option<String>)
:
required: falseThe operation name for the route.
request_models(impl Into<String>, impl Into<String>)
/set_request_models(Option<HashMap::<String, String>>)
:
required: falseThe request models for the route. Supported only for WebSocket APIs.
request_parameters(impl Into<String>, ParameterConstraints)
/set_request_parameters(Option<HashMap::<String, ParameterConstraints>>)
:
required: falseThe request parameters for the route. Supported only for WebSocket APIs.
route_id(impl Into<String>)
/set_route_id(Option<String>)
:
required: trueThe route ID.
route_key(impl Into<String>)
/set_route_key(Option<String>)
:
required: falseThe route key for the route.
route_response_selection_expression(impl Into<String>)
/set_route_response_selection_expression(Option<String>)
:
required: falseThe route response selection expression for the route. Supported only for WebSocket APIs.
target(impl Into<String>)
/set_target(Option<String>)
:
required: falseThe target for the route.
- On success, responds with
UpdateRouteOutput
with field(s):api_gateway_managed(Option<bool>)
:Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can’t modify the $default route key.
api_key_required(Option<bool>)
:Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
authorization_scopes(Option<Vec::<String>>)
:A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
authorization_type(Option<AuthorizationType>)
: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.
authorizer_id(Option<String>)
: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.
model_selection_expression(Option<String>)
:The model selection expression for the route. Supported only for WebSocket APIs.
operation_name(Option<String>)
:The operation name for the route.
request_models(Option<HashMap::<String, String>>)
:The request models for the route. Supported only for WebSocket APIs.
request_parameters(Option<HashMap::<String, ParameterConstraints>>)
:The request parameters for the route. Supported only for WebSocket APIs.
route_id(Option<String>)
:The route ID.
route_key(Option<String>)
:The route key for the route.
route_response_selection_expression(Option<String>)
:The route response selection expression for the route. Supported only for WebSocket APIs.
target(Option<String>)
:The target for the route.
- On failure, responds with
SdkError<UpdateRouteError>
source§impl Client
impl Client
sourcepub fn update_route_response(&self) -> UpdateRouteResponseFluentBuilder
pub fn update_route_response(&self) -> UpdateRouteResponseFluentBuilder
Constructs a fluent builder for the UpdateRouteResponse
operation.
- The fluent builder is configurable:
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
model_selection_expression(impl Into<String>)
/set_model_selection_expression(Option<String>)
:
required: falseThe model selection expression for the route response. Supported only for WebSocket APIs.
response_models(impl Into<String>, impl Into<String>)
/set_response_models(Option<HashMap::<String, String>>)
:
required: falseThe response models for the route response.
response_parameters(impl Into<String>, ParameterConstraints)
/set_response_parameters(Option<HashMap::<String, ParameterConstraints>>)
:
required: falseThe route response parameters.
route_id(impl Into<String>)
/set_route_id(Option<String>)
:
required: trueThe route ID.
route_response_id(impl Into<String>)
/set_route_response_id(Option<String>)
:
required: trueThe route response ID.
route_response_key(impl Into<String>)
/set_route_response_key(Option<String>)
:
required: falseThe route response key.
- On success, responds with
UpdateRouteResponseOutput
with field(s):model_selection_expression(Option<String>)
:Represents the model selection expression of a route response. Supported only for WebSocket APIs.
response_models(Option<HashMap::<String, String>>)
:Represents the response models of a route response.
response_parameters(Option<HashMap::<String, ParameterConstraints>>)
:Represents the response parameters of a route response.
route_response_id(Option<String>)
:Represents the identifier of a route response.
route_response_key(Option<String>)
:Represents the route response key of a route response.
- On failure, responds with
SdkError<UpdateRouteResponseError>
source§impl Client
impl Client
sourcepub fn update_stage(&self) -> UpdateStageFluentBuilder
pub fn update_stage(&self) -> UpdateStageFluentBuilder
Constructs a fluent builder for the UpdateStage
operation.
- The fluent builder is configurable:
access_log_settings(AccessLogSettings)
/set_access_log_settings(Option<AccessLogSettings>)
:
required: falseSettings for logging access in this stage.
api_id(impl Into<String>)
/set_api_id(Option<String>)
:
required: trueThe API identifier.
auto_deploy(bool)
/set_auto_deploy(Option<bool>)
:
required: falseSpecifies whether updates to an API automatically trigger a new deployment. The default value is false.
client_certificate_id(impl Into<String>)
/set_client_certificate_id(Option<String>)
:
required: falseThe identifier of a client certificate for a Stage.
default_route_settings(RouteSettings)
/set_default_route_settings(Option<RouteSettings>)
:
required: falseThe default route settings for the stage.
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: falseThe deployment identifier for the API stage. Can’t be updated if autoDeploy is enabled.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description for the API stage.
route_settings(impl Into<String>, RouteSettings)
/set_route_settings(Option<HashMap::<String, RouteSettings>>)
:
required: falseRoute settings for the stage.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
stage_variables(impl Into<String>, impl Into<String>)
/set_stage_variables(Option<HashMap::<String, String>>)
:
required: falseA 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-._~:/?#&=,]+.
- On success, responds with
UpdateStageOutput
with field(s):access_log_settings(Option<AccessLogSettings>)
:Settings for logging access in this stage.
api_gateway_managed(Option<bool>)
:Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can’t modify the $default stage.
auto_deploy(Option<bool>)
:Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
client_certificate_id(Option<String>)
:The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
created_date(Option<DateTime>)
:The timestamp when the stage was created.
default_route_settings(Option<RouteSettings>)
:Default route settings for the stage.
deployment_id(Option<String>)
:The identifier of the Deployment that the Stage is associated with. Can’t be updated if autoDeploy is enabled.
description(Option<String>)
:The description of the stage.
last_deployment_status_message(Option<String>)
:Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
last_updated_date(Option<DateTime>)
:The timestamp when the stage was last updated.
route_settings(Option<HashMap::<String, RouteSettings>>)
:Route settings for the stage, by routeKey.
stage_name(Option<String>)
:The name of the stage.
stage_variables(Option<HashMap::<String, String>>)
:A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<UpdateStageError>
source§impl Client
impl Client
sourcepub fn update_vpc_link(&self) -> UpdateVpcLinkFluentBuilder
pub fn update_vpc_link(&self) -> UpdateVpcLinkFluentBuilder
Constructs a fluent builder for the UpdateVpcLink
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the VPC link.
vpc_link_id(impl Into<String>)
/set_vpc_link_id(Option<String>)
:
required: trueThe ID of the VPC link.
- On success, responds with
UpdateVpcLinkOutput
with field(s):created_date(Option<DateTime>)
:The timestamp when the VPC link was created.
name(Option<String>)
:The name of the VPC link.
security_group_ids(Option<Vec::<String>>)
:A list of security group IDs for the VPC link.
subnet_ids(Option<Vec::<String>>)
:A list of subnet IDs to include in the VPC link.
tags(Option<HashMap::<String, String>>)
:Tags for the VPC link.
vpc_link_id(Option<String>)
:The ID of the VPC link.
vpc_link_status(Option<VpcLinkStatus>)
:The status of the VPC link.
vpc_link_status_message(Option<String>)
:A message summarizing the cause of the status of the VPC link.
vpc_link_version(Option<VpcLinkVersion>)
:The version of the VPC link.
- On failure, responds with
SdkError<UpdateVpcLinkError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.