Struct aws_sdk_apigatewayv2::client::Client

source · [−]

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* 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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_apigatewayv2::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_apigatewayv2::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_apigatewayv2::Client::from_conf(config);

Implementations

source

impl<C, M, R> Client<C, M, R>

source

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl<C, M, R> Client<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy,

source

pub fn create_api(&self) -> CreateApi<C, M, R>

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>):
  An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
- cors_configuration(Cors) / set_cors_configuration(Option<Cors>):
  A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- credentials_arn(impl Into<String>) / set_credentials_arn(Option<String>):
  This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To require that the caller’s identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
- description(impl Into<String>) / set_description(Option<String>):
  The description of the API.
- disable_schema_validation(bool) / set_disable_schema_validation(bool):
  Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- disable_execute_api_endpoint(bool) / set_disable_execute_api_endpoint(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.
- name(impl Into<String>) / set_name(Option<String>):
  The name of the API.
- protocol_type(ProtocolType) / set_protocol_type(Option<ProtocolType>):
  The API protocol.
- route_key(impl Into<String>) / set_route_key(Option<String>):
  This property is part of quick create. If you don’t specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can’t be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
- route_selection_expression(impl Into<String>) / set_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(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
  The collection of tags. Each tag element is associated with a given resource.
- target(impl Into<String>) / set_target(Option<String>):
  This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
- version(impl Into<String>) / set_version(Option<String>):
  A 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(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(bool):
  Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- disable_execute_api_endpoint(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

pub fn create_api_mapping(&self) -> CreateApiMapping<C, M, R>

Constructs a fluent builder for the CreateApiMapping operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- api_mapping_key(impl Into<String>) / set_api_mapping_key(Option<String>): The API mapping key.
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
  The domain name.
- stage(impl Into<String>) / set_stage(Option<String>):
  The 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

pub fn create_authorizer(&self) -> CreateAuthorizer<C, M, R>

Constructs a fluent builder for the CreateAuthorizer operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- authorizer_credentials_arn(impl Into<String>) / set_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_payload_format_version(impl Into<String>) / set_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(i32) / set_authorizer_result_ttl_in_seconds(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(AuthorizerType) / set_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(impl Into<String>) / set_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(bool) / set_enable_simple_responses(bool):
  Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
- identity_source(Vec<String>) / set_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(impl Into<String>) / set_identity_validation_expression(Option<String>):
  This parameter is not used.
- jwt_configuration(JwtConfiguration) / set_jwt_configuration(Option<JwtConfiguration>):
  Represents 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>):
  The 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(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(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

pub fn create_deployment(&self) -> CreateDeployment<C, M, R>

Constructs a fluent builder for the CreateDeployment operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- description(impl Into<String>) / set_description(Option<String>):
  The description for the deployment resource.
- stage_name(impl Into<String>) / set_stage_name(Option<String>):
  The name of the Stage resource for the Deployment resource to create.
On success, responds with CreateDeploymentOutput with field(s):
- auto_deployed(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

pub fn create_domain_name(&self) -> CreateDomainName<C, M, R>

Constructs a fluent builder for the CreateDomainName operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
  The domain name.
- domain_name_configurations(Vec<DomainNameConfiguration>) / set_domain_name_configurations(Option<Vec<DomainNameConfiguration>>):
  The domain name configurations.
- mutual_tls_authentication(MutualTlsAuthenticationInput) / set_mutual_tls_authentication(Option<MutualTlsAuthenticationInput>):
  The mutual TLS authentication configuration for a custom domain name.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
  The 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

pub fn create_integration(&self) -> CreateIntegration<C, M, R>

Constructs a fluent builder for the CreateIntegration operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- connection_id(impl Into<String>) / set_connection_id(Option<String>):
  The ID of the VPC link for a private integration. Supported only for HTTP APIs.
- connection_type(ConnectionType) / set_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(ContentHandlingStrategy) / set_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(impl Into<String>) / set_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(impl Into<String>) / set_description(Option<String>):
  The description of the integration.
- integration_method(impl Into<String>) / set_integration_method(Option<String>):
  Specifies the integration’s HTTP method type.
- integration_subtype(impl Into<String>) / set_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(IntegrationType) / set_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. 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>):
  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(PassthroughBehavior) / set_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(impl Into<String>) / set_payload_format_version(Option<String>):
  Specifies the format of the payload sent to an integration. Required for HTTP APIs.
- request_parameters(HashMap<String, String>) / set_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 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(HashMap<String, String>) / set_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(HashMap<String, HashMap<String, String>>) / set_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(impl Into<String>) / set_template_selection_expression(Option<String>):
  The template selection expression for the integration.
- timeout_in_millis(i32) / set_timeout_in_millis(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(TlsConfigInput) / set_tls_config(Option<TlsConfigInput>):
  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 success, responds with CreateIntegrationOutput with field(s):
- api_gateway_managed(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 itegrations, 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(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

pub fn create_integration_response(&self) -> CreateIntegrationResponse<C, M, R>

Constructs a fluent builder for the CreateIntegrationResponse operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- content_handling_strategy(ContentHandlingStrategy) / set_content_handling_strategy(Option<ContentHandlingStrategy>):
  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>):
  The integration ID.
- integration_response_key(impl Into<String>) / set_integration_response_key(Option<String>):
  The integration response key.
- response_parameters(HashMap<String, String>) / set_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(HashMap<String, String>) / set_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(impl Into<String>) / set_template_selection_expression(Option<String>):
  The 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

pub fn create_model(&self) -> CreateModel<C, M, R>

Constructs a fluent builder for the CreateModel operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- content_type(impl Into<String>) / set_content_type(Option<String>):
  The content-type for the model, for example, “application/json”.
- description(impl Into<String>) / set_description(Option<String>):
  The description of the model.
- name(impl Into<String>) / set_name(Option<String>):
  The name of the model. Must be alphanumeric.
- schema(impl Into<String>) / set_schema(Option<String>):
  The 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

pub fn create_route(&self) -> CreateRoute<C, M, R>

Constructs a fluent builder for the CreateRoute operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- api_key_required(bool) / set_api_key_required(bool):
  Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
- authorization_scopes(Vec<String>) / set_authorization_scopes(Option<Vec<String>>):
  The authorization scopes supported by this route.
- authorization_type(AuthorizationType) / set_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(impl Into<String>) / set_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(impl Into<String>) / set_model_selection_expression(Option<String>):
  The model selection expression for the route. Supported only for WebSocket APIs.
- operation_name(impl Into<String>) / set_operation_name(Option<String>):
  The operation name for the route.
- request_models(HashMap<String, String>) / set_request_models(Option<HashMap<String, String>>):
  The request models for the route. Supported only for WebSocket APIs.
- request_parameters(HashMap<String, ParameterConstraints>) / set_request_parameters(Option<HashMap<String, ParameterConstraints>>):
  The request parameters for the route. Supported only for WebSocket APIs.
- route_key(impl Into<String>) / set_route_key(Option<String>):
  The route key for the route.
- route_response_selection_expression(impl Into<String>) / set_route_response_selection_expression(Option<String>):
  The route response selection expression for the route. Supported only for WebSocket APIs.
- target(impl Into<String>) / set_target(Option<String>):
  The target for the route.
On success, responds with CreateRouteOutput with field(s):
- api_gateway_managed(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(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

pub fn create_route_response(&self) -> CreateRouteResponse<C, M, R>

Constructs a fluent builder for the CreateRouteResponse operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- model_selection_expression(impl Into<String>) / set_model_selection_expression(Option<String>):
  The model selection expression for the route response. Supported only for WebSocket APIs.
- response_models(HashMap<String, String>) / set_response_models(Option<HashMap<String, String>>):
  The response models for the route response.
- response_parameters(HashMap<String, ParameterConstraints>) / set_response_parameters(Option<HashMap<String, ParameterConstraints>>):
  The route response parameters.
- route_id(impl Into<String>) / set_route_id(Option<String>):
  The route ID.
- route_response_key(impl Into<String>) / set_route_response_key(Option<String>):
  The 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

pub fn create_stage(&self) -> CreateStage<C, M, R>

Constructs a fluent builder for the CreateStage operation.

The fluent builder is configurable:
- access_log_settings(AccessLogSettings) / set_access_log_settings(Option<AccessLogSettings>):
  Settings for logging access in this stage.
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- auto_deploy(bool) / set_auto_deploy(bool):
  Specifies 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>):
  The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
- default_route_settings(RouteSettings) / set_default_route_settings(Option<RouteSettings>):
  The default route settings for the stage.
- deployment_id(impl Into<String>) / set_deployment_id(Option<String>):
  The deployment identifier of the API stage.
- description(impl Into<String>) / set_description(Option<String>):
  The description for the API stage.
- route_settings(HashMap<String, RouteSettings>) / set_route_settings(Option<HashMap<String, RouteSettings>>):
  Route settings for the stage, by routeKey.
- stage_name(impl Into<String>) / set_stage_name(Option<String>):
  The name of the stage.
- stage_variables(HashMap<String, String>) / set_stage_variables(Option<HashMap<String, String>>):
  A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
  The 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(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(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

pub fn create_vpc_link(&self) -> CreateVpcLink<C, M, R>

Constructs a fluent builder for the CreateVpcLink operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
  The name of the VPC link.
- security_group_ids(Vec<String>) / set_security_group_ids(Option<Vec<String>>):
  A list of security group IDs for the VPC link.
- subnet_ids(Vec<String>) / set_subnet_ids(Option<Vec<String>>):
  A list of subnet IDs to include in the VPC link.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
  A 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

pub fn delete_access_log_settings(&self) -> DeleteAccessLogSettings<C, M, R>

Constructs a fluent builder for the DeleteAccessLogSettings operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- stage_name(impl Into<String>) / set_stage_name(Option<String>):
  The 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

pub fn delete_api(&self) -> DeleteApi<C, M, R>

Constructs a fluent builder for the DeleteApi operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
On success, responds with DeleteApiOutput
On failure, responds with SdkError<DeleteApiError>

source

pub fn delete_api_mapping(&self) -> DeleteApiMapping<C, M, R>

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>):
  The API mapping identifier.
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
  The domain name.
On success, responds with DeleteApiMappingOutput
On failure, responds with SdkError<DeleteApiMappingError>

source

pub fn delete_authorizer(&self) -> DeleteAuthorizer<C, M, R>

Constructs a fluent builder for the DeleteAuthorizer operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- authorizer_id(impl Into<String>) / set_authorizer_id(Option<String>):
  The authorizer identifier.
On success, responds with DeleteAuthorizerOutput
On failure, responds with SdkError<DeleteAuthorizerError>

source

pub fn delete_cors_configuration(&self) -> DeleteCorsConfiguration<C, M, R>

Constructs a fluent builder for the DeleteCorsConfiguration operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
On success, responds with DeleteCorsConfigurationOutput
On failure, responds with SdkError<DeleteCorsConfigurationError>

source

pub fn delete_deployment(&self) -> DeleteDeployment<C, M, R>

Constructs a fluent builder for the DeleteDeployment operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- deployment_id(impl Into<String>) / set_deployment_id(Option<String>):
  The deployment ID.
On success, responds with DeleteDeploymentOutput
On failure, responds with SdkError<DeleteDeploymentError>

source

pub fn delete_domain_name(&self) -> DeleteDomainName<C, M, R>

Constructs a fluent builder for the DeleteDomainName operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
  The domain name.
On success, responds with DeleteDomainNameOutput
On failure, responds with SdkError<DeleteDomainNameError>

source

pub fn delete_integration(&self) -> DeleteIntegration<C, M, R>

Constructs a fluent builder for the DeleteIntegration operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- integration_id(impl Into<String>) / set_integration_id(Option<String>):
  The integration ID.
On success, responds with DeleteIntegrationOutput
On failure, responds with SdkError<DeleteIntegrationError>

source

pub fn delete_integration_response(&self) -> DeleteIntegrationResponse<C, M, R>

Constructs a fluent builder for the DeleteIntegrationResponse operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- integration_id(impl Into<String>) / set_integration_id(Option<String>):
  The integration ID.
- integration_response_id(impl Into<String>) / set_integration_response_id(Option<String>):
  The integration response ID.
On success, responds with DeleteIntegrationResponseOutput
On failure, responds with SdkError<DeleteIntegrationResponseError>

source

pub fn delete_model(&self) -> DeleteModel<C, M, R>

Constructs a fluent builder for the DeleteModel operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- model_id(impl Into<String>) / set_model_id(Option<String>):
  The model ID.
On success, responds with DeleteModelOutput
On failure, responds with SdkError<DeleteModelError>

source

pub fn delete_route(&self) -> DeleteRoute<C, M, R>

Constructs a fluent builder for the DeleteRoute operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- route_id(impl Into<String>) / set_route_id(Option<String>):
  The route ID.
On success, responds with DeleteRouteOutput
On failure, responds with SdkError<DeleteRouteError>

source

pub fn delete_route_request_parameter(
&self
) -> DeleteRouteRequestParameter<C, M, R>

Constructs a fluent builder for the DeleteRouteRequestParameter operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- request_parameter_key(impl Into<String>) / set_request_parameter_key(Option<String>):
  The route request parameter key.
- route_id(impl Into<String>) / set_route_id(Option<String>):
  The route ID.
On success, responds with DeleteRouteRequestParameterOutput
On failure, responds with SdkError<DeleteRouteRequestParameterError>

source

pub fn delete_route_response(&self) -> DeleteRouteResponse<C, M, R>

Constructs a fluent builder for the DeleteRouteResponse operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- route_id(impl Into<String>) / set_route_id(Option<String>):
  The route ID.
- route_response_id(impl Into<String>) / set_route_response_id(Option<String>):
  The route response ID.
On success, responds with DeleteRouteResponseOutput
On failure, responds with SdkError<DeleteRouteResponseError>

source

pub fn delete_route_settings(&self) -> DeleteRouteSettings<C, M, R>

Constructs a fluent builder for the DeleteRouteSettings operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- route_key(impl Into<String>) / set_route_key(Option<String>):
  The route key.
- stage_name(impl Into<String>) / set_stage_name(Option<String>):
  The 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

pub fn delete_stage(&self) -> DeleteStage<C, M, R>

Constructs a fluent builder for the DeleteStage operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- stage_name(impl Into<String>) / set_stage_name(Option<String>):
  The 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

pub fn delete_vpc_link(&self) -> DeleteVpcLink<C, M, R>

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>):
  The ID of the VPC link.
On success, responds with DeleteVpcLinkOutput
On failure, responds with SdkError<DeleteVpcLinkError>

source

pub fn export_api(&self) -> ExportApi<C, M, R>

Constructs a fluent builder for the ExportApi operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- export_version(impl Into<String>) / set_export_version(Option<String>):
  The 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(bool):
  Specifies 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>):
  The output type of the exported definition file. Valid values are JSON and YAML.
- specification(impl Into<String>) / set_specification(Option<String>):
  The 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>):
  The 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

pub fn get_api(&self) -> GetApi<C, M, R>

Constructs a fluent builder for the GetApi operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The 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(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(bool):
  Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- disable_execute_api_endpoint(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

pub fn get_api_mapping(&self) -> GetApiMapping<C, M, R>

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>):
  The API mapping identifier.
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
  The 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

pub fn get_api_mappings(&self) -> GetApiMappings<C, M, R>

Constructs a fluent builder for the GetApiMappings operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
  The domain name.
- max_results(impl Into<String>) / set_max_results(Option<String>):
  The maximum number of elements to be returned for this resource.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  The 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

pub fn get_apis(&self) -> GetApis<C, M, R>

Constructs a fluent builder for the GetApis operation.

The fluent builder is configurable:
- max_results(impl Into<String>) / set_max_results(Option<String>):
  The maximum number of elements to be returned for this resource.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  The 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

pub fn get_authorizer(&self) -> GetAuthorizer<C, M, R>

Constructs a fluent builder for the GetAuthorizer operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- authorizer_id(impl Into<String>) / set_authorizer_id(Option<String>):
  The 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(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(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

pub fn get_authorizers(&self) -> GetAuthorizers<C, M, R>

Constructs a fluent builder for the GetAuthorizers operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- max_results(impl Into<String>) / set_max_results(Option<String>):
  The maximum number of elements to be returned for this resource.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  The 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

pub fn get_deployment(&self) -> GetDeployment<C, M, R>

Constructs a fluent builder for the GetDeployment operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- deployment_id(impl Into<String>) / set_deployment_id(Option<String>):
  The deployment ID.
On success, responds with GetDeploymentOutput with field(s):
- auto_deployed(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

pub fn get_deployments(&self) -> GetDeployments<C, M, R>

Constructs a fluent builder for the GetDeployments operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- max_results(impl Into<String>) / set_max_results(Option<String>):
  The maximum number of elements to be returned for this resource.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  The 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

pub fn get_domain_name(&self) -> GetDomainName<C, M, R>

Constructs a fluent builder for the GetDomainName operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
  The 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

pub fn get_domain_names(&self) -> GetDomainNames<C, M, R>

Constructs a fluent builder for the GetDomainNames operation.

The fluent builder is configurable:
- max_results(impl Into<String>) / set_max_results(Option<String>):
  The maximum number of elements to be returned for this resource.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  The 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

pub fn get_integration(&self) -> GetIntegration<C, M, R>

Constructs a fluent builder for the GetIntegration operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- integration_id(impl Into<String>) / set_integration_id(Option<String>):
  The integration ID.
On success, responds with GetIntegrationOutput with field(s):
- api_gateway_managed(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 itegrations, 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(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

pub fn get_integration_response(&self) -> GetIntegrationResponse<C, M, R>

Constructs a fluent builder for the GetIntegrationResponse operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- integration_id(impl Into<String>) / set_integration_id(Option<String>):
  The integration ID.
- integration_response_id(impl Into<String>) / set_integration_response_id(Option<String>):
  The 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

pub fn get_integration_responses(&self) -> GetIntegrationResponses<C, M, R>

Constructs a fluent builder for the GetIntegrationResponses operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- integration_id(impl Into<String>) / set_integration_id(Option<String>):
  The integration ID.
- max_results(impl Into<String>) / set_max_results(Option<String>):
  The maximum number of elements to be returned for this resource.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  The 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

pub fn get_integrations(&self) -> GetIntegrations<C, M, R>

Constructs a fluent builder for the GetIntegrations operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- max_results(impl Into<String>) / set_max_results(Option<String>):
  The maximum number of elements to be returned for this resource.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  The 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

pub fn get_model(&self) -> GetModel<C, M, R>

Constructs a fluent builder for the GetModel operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- model_id(impl Into<String>) / set_model_id(Option<String>):
  The 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

pub fn get_models(&self) -> GetModels<C, M, R>

Constructs a fluent builder for the GetModels operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- max_results(impl Into<String>) / set_max_results(Option<String>):
  The maximum number of elements to be returned for this resource.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  The 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

pub fn get_model_template(&self) -> GetModelTemplate<C, M, R>

Constructs a fluent builder for the GetModelTemplate operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- model_id(impl Into<String>) / set_model_id(Option<String>):
  The model ID.
On success, responds with GetModelTemplateOutput with field(s):
- value(Option<String>):
  The template value.
On failure, responds with SdkError<GetModelTemplateError>

source

pub fn get_route(&self) -> GetRoute<C, M, R>

Constructs a fluent builder for the GetRoute operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- route_id(impl Into<String>) / set_route_id(Option<String>):
  The route ID.
On success, responds with GetRouteOutput with field(s):
- api_gateway_managed(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(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

pub fn get_route_response(&self) -> GetRouteResponse<C, M, R>

Constructs a fluent builder for the GetRouteResponse operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- route_id(impl Into<String>) / set_route_id(Option<String>):
  The route ID.
- route_response_id(impl Into<String>) / set_route_response_id(Option<String>):
  The 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

pub fn get_route_responses(&self) -> GetRouteResponses<C, M, R>

Constructs a fluent builder for the GetRouteResponses operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- max_results(impl Into<String>) / set_max_results(Option<String>):
  The maximum number of elements to be returned for this resource.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  The 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>):
  The 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

pub fn get_routes(&self) -> GetRoutes<C, M, R>

Constructs a fluent builder for the GetRoutes operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- max_results(impl Into<String>) / set_max_results(Option<String>):
  The maximum number of elements to be returned for this resource.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  The 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

pub fn get_stage(&self) -> GetStage<C, M, R>

Constructs a fluent builder for the GetStage operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- stage_name(impl Into<String>) / set_stage_name(Option<String>):
  The 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(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(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

pub fn get_stages(&self) -> GetStages<C, M, R>

Constructs a fluent builder for the GetStages operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- max_results(impl Into<String>) / set_max_results(Option<String>):
  The maximum number of elements to be returned for this resource.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  The 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

pub fn get_tags(&self) -> GetTags<C, M, R>

Constructs a fluent builder for the GetTags operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
  The 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

pub fn get_vpc_link(&self) -> GetVpcLink<C, M, R>

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>):
  The 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

pub fn get_vpc_links(&self) -> GetVpcLinks<C, M, R>

Constructs a fluent builder for the GetVpcLinks operation.

The fluent builder is configurable:
- max_results(impl Into<String>) / set_max_results(Option<String>):
  The maximum number of elements to be returned for this resource.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  The 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

pub fn import_api(&self) -> ImportApi<C, M, R>

Constructs a fluent builder for the ImportApi operation.

The fluent builder is configurable:
- basepath(impl Into<String>) / set_basepath(Option<String>):
  Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
- body(impl Into<String>) / set_body(Option<String>):
  The OpenAPI definition. Supported only for HTTP APIs.
- fail_on_warnings(bool) / set_fail_on_warnings(bool):
  Specifies 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(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(bool):
  Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- disable_execute_api_endpoint(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

pub fn reimport_api(&self) -> ReimportApi<C, M, R>

Constructs a fluent builder for the ReimportApi operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- basepath(impl Into<String>) / set_basepath(Option<String>):
  Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
- body(impl Into<String>) / set_body(Option<String>):
  The OpenAPI definition. Supported only for HTTP APIs.
- fail_on_warnings(bool) / set_fail_on_warnings(bool):
  Specifies 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(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(bool):
  Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- disable_execute_api_endpoint(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

pub fn reset_authorizers_cache(&self) -> ResetAuthorizersCache<C, M, R>

Constructs a fluent builder for the ResetAuthorizersCache operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- stage_name(impl Into<String>) / set_stage_name(Option<String>):
  The 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

pub fn tag_resource(&self) -> TagResource<C, M, R>

Constructs a fluent builder for the TagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
  The resource ARN for the tag.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
  The collection of tags. Each tag element is associated with a given resource.
On success, responds with TagResourceOutput
On failure, responds with SdkError<TagResourceError>

source

pub fn untag_resource(&self) -> UntagResource<C, M, R>

Constructs a fluent builder for the UntagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
  The resource ARN for the tag.
- tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):
  The Tag keys to delete
On success, responds with UntagResourceOutput
On failure, responds with SdkError<UntagResourceError>

source

pub fn update_api(&self) -> UpdateApi<C, M, R>

Constructs a fluent builder for the UpdateApi operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- api_key_selection_expression(impl Into<String>) / set_api_key_selection_expression(Option<String>):
  An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
- cors_configuration(Cors) / set_cors_configuration(Option<Cors>):
  A CORS configuration. Supported only for HTTP APIs.
- credentials_arn(impl Into<String>) / set_credentials_arn(Option<String>):
  This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To require that the caller’s identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, 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>):
  The description of the API.
- disable_schema_validation(bool) / set_disable_schema_validation(bool):
  Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- disable_execute_api_endpoint(bool) / set_disable_execute_api_endpoint(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.
- name(impl Into<String>) / set_name(Option<String>):
  The name of the API.
- route_key(impl Into<String>) / set_route_key(Option<String>):
  This 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>):
  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.
- target(impl Into<String>) / set_target(Option<String>):
  This 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>):
  A 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(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(bool):
  Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- disable_execute_api_endpoint(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

pub fn update_api_mapping(&self) -> UpdateApiMapping<C, M, R>

Constructs a fluent builder for the UpdateApiMapping operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- api_mapping_id(impl Into<String>) / set_api_mapping_id(Option<String>):
  The API mapping identifier.
- api_mapping_key(impl Into<String>) / set_api_mapping_key(Option<String>):
  The API mapping key.
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
  The domain name.
- stage(impl Into<String>) / set_stage(Option<String>):
  The 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

pub fn update_authorizer(&self) -> UpdateAuthorizer<C, M, R>

Constructs a fluent builder for the UpdateAuthorizer operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- authorizer_credentials_arn(impl Into<String>) / set_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.
- authorizer_id(impl Into<String>) / set_authorizer_id(Option<String>):
  The authorizer identifier.
- authorizer_payload_format_version(impl Into<String>) / set_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(i32) / set_authorizer_result_ttl_in_seconds(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(AuthorizerType) / set_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(impl Into<String>) / set_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(bool) / set_enable_simple_responses(bool):
  Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
- identity_source(Vec<String>) / set_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(impl Into<String>) / set_identity_validation_expression(Option<String>):
  This parameter is not used.
- jwt_configuration(JwtConfiguration) / set_jwt_configuration(Option<JwtConfiguration>):
  Represents 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>):
  The 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(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(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

pub fn update_deployment(&self) -> UpdateDeployment<C, M, R>

Constructs a fluent builder for the UpdateDeployment operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- deployment_id(impl Into<String>) / set_deployment_id(Option<String>):
  The deployment ID.
- description(impl Into<String>) / set_description(Option<String>):
  The description for the deployment resource.
On success, responds with UpdateDeploymentOutput with field(s):
- auto_deployed(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

pub fn update_domain_name(&self) -> UpdateDomainName<C, M, R>

Constructs a fluent builder for the UpdateDomainName operation.

The fluent builder is configurable:
- domain_name(impl Into<String>) / set_domain_name(Option<String>):
  The domain name.
- domain_name_configurations(Vec<DomainNameConfiguration>) / set_domain_name_configurations(Option<Vec<DomainNameConfiguration>>):
  The domain name configurations.
- mutual_tls_authentication(MutualTlsAuthenticationInput) / set_mutual_tls_authentication(Option<MutualTlsAuthenticationInput>):
  The 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

pub fn update_integration(&self) -> UpdateIntegration<C, M, R>

Constructs a fluent builder for the UpdateIntegration operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- connection_id(impl Into<String>) / set_connection_id(Option<String>):
  The ID of the VPC link for a private integration. Supported only for HTTP APIs.
- connection_type(ConnectionType) / set_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(ContentHandlingStrategy) / set_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(impl Into<String>) / set_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(impl Into<String>) / set_description(Option<String>):
  The description of the integration
- integration_id(impl Into<String>) / set_integration_id(Option<String>):
  The integration ID.
- integration_method(impl Into<String>) / set_integration_method(Option<String>):
  Specifies the integration’s HTTP method type.
- integration_subtype(impl Into<String>) / set_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(IntegrationType) / set_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. 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>):
  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(PassthroughBehavior) / set_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(impl Into<String>) / set_payload_format_version(Option<String>):
  Specifies the format of the payload sent to an integration. Required for HTTP APIs.
- request_parameters(HashMap<String, String>) / set_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 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(HashMap<String, String>) / set_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(HashMap<String, HashMap<String, String>>) / set_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(impl Into<String>) / set_template_selection_expression(Option<String>):
  The template selection expression for the integration.
- timeout_in_millis(i32) / set_timeout_in_millis(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(TlsConfigInput) / set_tls_config(Option<TlsConfigInput>):
  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 success, responds with UpdateIntegrationOutput with field(s):
- api_gateway_managed(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 itegrations, 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(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

pub fn update_integration_response(&self) -> UpdateIntegrationResponse<C, M, R>

Constructs a fluent builder for the UpdateIntegrationResponse operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- content_handling_strategy(ContentHandlingStrategy) / set_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_id(impl Into<String>) / set_integration_id(Option<String>):
  The integration ID.
- integration_response_id(impl Into<String>) / set_integration_response_id(Option<String>):
  The integration response ID.
- integration_response_key(impl Into<String>) / set_integration_response_key(Option<String>):
  The integration response key.
- response_parameters(HashMap<String, String>) / set_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(HashMap<String, String>) / set_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(impl Into<String>) / set_template_selection_expression(Option<String>):
  The 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

pub fn update_model(&self) -> UpdateModel<C, M, R>

Constructs a fluent builder for the UpdateModel operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- content_type(impl Into<String>) / set_content_type(Option<String>):
  The content-type for the model, for example, “application/json”.
- description(impl Into<String>) / set_description(Option<String>):
  The description of the model.
- model_id(impl Into<String>) / set_model_id(Option<String>):
  The model ID.
- name(impl Into<String>) / set_name(Option<String>):
  The name of the model.
- schema(impl Into<String>) / set_schema(Option<String>):
  The 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

pub fn update_route(&self) -> UpdateRoute<C, M, R>

Constructs a fluent builder for the UpdateRoute operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- api_key_required(bool) / set_api_key_required(bool):
  Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
- authorization_scopes(Vec<String>) / set_authorization_scopes(Option<Vec<String>>):
  The authorization scopes supported by this route.
- authorization_type(AuthorizationType) / set_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(impl Into<String>) / set_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(impl Into<String>) / set_model_selection_expression(Option<String>):
  The model selection expression for the route. Supported only for WebSocket APIs.
- operation_name(impl Into<String>) / set_operation_name(Option<String>):
  The operation name for the route.
- request_models(HashMap<String, String>) / set_request_models(Option<HashMap<String, String>>):
  The request models for the route. Supported only for WebSocket APIs.
- request_parameters(HashMap<String, ParameterConstraints>) / set_request_parameters(Option<HashMap<String, ParameterConstraints>>):
  The request parameters for the route. Supported only for WebSocket APIs.
- route_id(impl Into<String>) / set_route_id(Option<String>):
  The route ID.
- route_key(impl Into<String>) / set_route_key(Option<String>):
  The route key for the route.
- route_response_selection_expression(impl Into<String>) / set_route_response_selection_expression(Option<String>):
  The route response selection expression for the route. Supported only for WebSocket APIs.
- target(impl Into<String>) / set_target(Option<String>):
  The target for the route.
On success, responds with UpdateRouteOutput with field(s):
- api_gateway_managed(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(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

pub fn update_route_response(&self) -> UpdateRouteResponse<C, M, R>

Constructs a fluent builder for the UpdateRouteResponse operation.

The fluent builder is configurable:
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- model_selection_expression(impl Into<String>) / set_model_selection_expression(Option<String>):
  The model selection expression for the route response. Supported only for WebSocket APIs.
- response_models(HashMap<String, String>) / set_response_models(Option<HashMap<String, String>>):
  The response models for the route response.
- response_parameters(HashMap<String, ParameterConstraints>) / set_response_parameters(Option<HashMap<String, ParameterConstraints>>):
  The route response parameters.
- route_id(impl Into<String>) / set_route_id(Option<String>):
  The route ID.
- route_response_id(impl Into<String>) / set_route_response_id(Option<String>):
  The route response ID.
- route_response_key(impl Into<String>) / set_route_response_key(Option<String>):
  The 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

pub fn update_stage(&self) -> UpdateStage<C, M, R>

Constructs a fluent builder for the UpdateStage operation.

The fluent builder is configurable:
- access_log_settings(AccessLogSettings) / set_access_log_settings(Option<AccessLogSettings>):
  Settings for logging access in this stage.
- api_id(impl Into<String>) / set_api_id(Option<String>):
  The API identifier.
- auto_deploy(bool) / set_auto_deploy(bool):
  Specifies 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>):
  The identifier of a client certificate for a Stage.
- default_route_settings(RouteSettings) / set_default_route_settings(Option<RouteSettings>):
  The default route settings for the stage.
- deployment_id(impl Into<String>) / set_deployment_id(Option<String>):
  The deployment identifier for the API stage. Can’t be updated if autoDeploy is enabled.
- description(impl Into<String>) / set_description(Option<String>):
  The description for the API stage.
- route_settings(HashMap<String, RouteSettings>) / set_route_settings(Option<HashMap<String, RouteSettings>>):
  Route settings for the stage.
- stage_name(impl Into<String>) / set_stage_name(Option<String>):
  The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
- stage_variables(HashMap<String, String>) / set_stage_variables(Option<HashMap<String, String>>):
  A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
On success, responds with UpdateStageOutput with field(s):
- access_log_settings(Option<AccessLogSettings>):
  Settings for logging access in this stage.
- api_gateway_managed(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(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>