Struct aws_sdk_apigateway::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon API Gateway
Client for invoking operations on Amazon API Gateway. Each operation on Amazon API Gateway is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_apigateway::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_apigateway::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CreateApiKey
operation has
a Client::create_api_key
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.create_api_key()
.name("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn create_api_key(&self) -> CreateApiKeyFluentBuilder
pub fn create_api_key(&self) -> CreateApiKeyFluentBuilder
Constructs a fluent builder for the CreateApiKey
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the ApiKey.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the ApiKey.
enabled(bool)
/set_enabled(Option<bool>)
:
required: falseSpecifies whether the ApiKey can be used by callers.
generate_distinct_id(bool)
/set_generate_distinct_id(Option<bool>)
:
required: falseSpecifies whether (
true
) or not (false
) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.value(impl Into<String>)
/set_value(Option<String>)
:
required: falseSpecifies a value of the API key.
stage_keys(StageKey)
/set_stage_keys(Option<Vec::<StageKey>>)
:
required: falseDEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
customer_id(impl Into<String>)
/set_customer_id(Option<String>)
:
required: falseAn Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters.
- On success, responds with
CreateApiKeyOutput
with field(s):id(Option<String>)
:The identifier of the API Key.
value(Option<String>)
:The value of the API Key.
name(Option<String>)
:The name of the API Key.
customer_id(Option<String>)
:An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
description(Option<String>)
:The description of the API Key.
enabled(bool)
:Specifies whether the API Key can be used by callers.
created_date(Option<DateTime>)
:The timestamp when the API Key was created.
last_updated_date(Option<DateTime>)
:The timestamp when the API Key was last updated.
stage_keys(Option<Vec::<String>>)
:A list of Stage resources that are associated with the ApiKey resource.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<CreateApiKeyError>
source§impl Client
impl Client
Constructs a fluent builder for the CreateAuthorizer
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the authorizer.
r#type(AuthorizerType)
/set_type(Option<AuthorizerType>)
:
required: trueThe authorizer type. Valid values are
TOKEN
for a Lambda function using a single authorization token submitted in a custom header,REQUEST
for a Lambda function using incoming request parameters, andCOGNITO_USER_POOLS
for using an Amazon Cognito user pool.provider_arns(impl Into<String>)
/set_provider_arns(Option<Vec::<String>>)
:
required: falseA list of the Amazon Cognito user pool ARNs for the
COGNITO_USER_POOLS
authorizer. Each element is of this format:arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}
. For aTOKEN
orREQUEST
authorizer, this is not defined.auth_type(impl Into<String>)
/set_auth_type(Option<String>)
:
required: falseOptional customer-defined field, used in OpenAPI imports and exports without functional impact.
authorizer_uri(impl Into<String>)
/set_authorizer_uri(Option<String>)
:
required: falseSpecifies the authorizer’s Uniform Resource Identifier (URI). For
TOKEN
orREQUEST
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 formarn: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
.authorizer_credentials(impl Into<String>)
/set_authorizer_credentials(Option<String>)
:
required: falseSpecifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
identity_source(impl Into<String>)
/set_identity_source(Option<String>)
:
required: falseThe identity source for which authorization is requested. For a
TOKEN
orCOGNITO_USER_POOLS
authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name isAuth
, the header mapping expression ismethod.request.header.Auth
. For theREQUEST
authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if anAuth
header, aName
query string parameter are defined as identity sources, this value ismethod.request.header.Auth, method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.identity_validation_expression(impl Into<String>)
/set_identity_validation_expression(Option<String>)
:
required: falseA validation expression for the incoming identity token. For
TOKEN
authorizers, this value is a regular expression. ForCOGNITO_USER_POOLS
authorizers, API Gateway will match theaud
field of the incoming token from the client against the specified regular expression. It will invoke the authorizer’s Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to theREQUEST
authorizer.authorizer_result_ttl_in_seconds(i32)
/set_authorizer_result_ttl_in_seconds(Option<i32>)
:
required: falseThe TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- On success, responds with
CreateAuthorizerOutput
with field(s):id(Option<String>)
:The identifier for the authorizer resource.
name(Option<String>)
:The name of the authorizer.
r#type(Option<AuthorizerType>)
:The authorizer type. Valid values are
TOKEN
for a Lambda function using a single authorization token submitted in a custom header,REQUEST
for a Lambda function using incoming request parameters, andCOGNITO_USER_POOLS
for using an Amazon Cognito user pool.provider_arns(Option<Vec::<String>>)
:A list of the Amazon Cognito user pool ARNs for the
COGNITO_USER_POOLS
authorizer. Each element is of this format:arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}
. For aTOKEN
orREQUEST
authorizer, this is not defined.auth_type(Option<String>)
:Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
authorizer_uri(Option<String>)
:Specifies the authorizer’s Uniform Resource Identifier (URI). For
TOKEN
orREQUEST
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 formarn: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
.authorizer_credentials(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, specify null.
identity_source(Option<String>)
:The identity source for which authorization is requested. For a
TOKEN
orCOGNITO_USER_POOLS
authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name isAuth
, the header mapping expression ismethod.request.header.Auth
. For theREQUEST
authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if anAuth
header, aName
query string parameter are defined as identity sources, this value ismethod.request.header.Auth
,method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.identity_validation_expression(Option<String>)
:A validation expression for the incoming identity token. For
TOKEN
authorizers, this value is a regular expression. ForCOGNITO_USER_POOLS
authorizers, API Gateway will match theaud
field of the incoming token from the client against the specified regular expression. It will invoke the authorizer’s Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to theREQUEST
authorizer.authorizer_result_ttl_in_seconds(Option<i32>)
:The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- On failure, responds with
SdkError<CreateAuthorizerError>
source§impl Client
impl Client
sourcepub fn create_base_path_mapping(&self) -> CreateBasePathMappingFluentBuilder
pub fn create_base_path_mapping(&self) -> CreateBasePathMappingFluentBuilder
Constructs a fluent builder for the CreateBasePathMapping
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name of the BasePathMapping resource to create.
base_path(impl Into<String>)
/set_base_path(Option<String>)
:
required: falseThe base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify ‘(none)’ if you do not want callers to specify a base path name after the domain name.
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
stage(impl Into<String>)
/set_stage(Option<String>)
:
required: falseThe name of the API’s stage that you want to use for this mapping. Specify ‘(none)’ if you want callers to explicitly specify the stage name after any base path name.
- On success, responds with
CreateBasePathMappingOutput
with field(s):base_path(Option<String>)
:The base path name that callers of the API must provide as part of the URL after the domain name.
rest_api_id(Option<String>)
:The string identifier of the associated RestApi.
stage(Option<String>)
:The name of the associated stage.
- On failure, responds with
SdkError<CreateBasePathMappingError>
source§impl Client
impl Client
sourcepub fn create_deployment(&self) -> CreateDeploymentFluentBuilder
pub fn create_deployment(&self) -> CreateDeploymentFluentBuilder
Constructs a fluent builder for the CreateDeployment
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: falseThe name of the Stage resource for the Deployment resource to create.
stage_description(impl Into<String>)
/set_stage_description(Option<String>)
:
required: falseThe description of the Stage resource for the Deployment resource to create.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description for the Deployment resource to create.
cache_cluster_enabled(bool)
/set_cache_cluster_enabled(Option<bool>)
:
required: falseEnables a cache cluster for the Stage resource specified in the input.
cache_cluster_size(CacheClusterSize)
/set_cache_cluster_size(Option<CacheClusterSize>)
:
required: falseThe stage’s cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
variables(impl Into<String>, impl Into<String>)
/set_variables(Option<HashMap::<String, String>>)
:
required: falseA map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match
[A-Za-z0-9-._~:/?#&=,]+
.canary_settings(DeploymentCanarySettings)
/set_canary_settings(Option<DeploymentCanarySettings>)
:
required: falseThe input configuration for the canary deployment when the deployment is a canary release deployment.
tracing_enabled(bool)
/set_tracing_enabled(Option<bool>)
:
required: falseSpecifies whether active tracing with X-ray is enabled for the Stage.
- On success, responds with
CreateDeploymentOutput
with field(s):id(Option<String>)
:The identifier for the deployment resource.
description(Option<String>)
:The description for the deployment resource.
created_date(Option<DateTime>)
:The date and time that the deployment resource was created.
api_summary(Option<HashMap::<String, HashMap::<String, MethodSnapshot>>>)
:A summary of the RestApi at the date and time that the deployment resource was created.
- On failure, responds with
SdkError<CreateDeploymentError>
source§impl Client
impl Client
sourcepub fn create_documentation_part(&self) -> CreateDocumentationPartFluentBuilder
pub fn create_documentation_part(&self) -> CreateDocumentationPartFluentBuilder
Constructs a fluent builder for the CreateDocumentationPart
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
location(DocumentationPartLocation)
/set_location(Option<DocumentationPartLocation>)
:
required: trueThe location of the targeted API entity of the to-be-created documentation part.
properties(impl Into<String>)
/set_properties(Option<String>)
:
required: trueThe new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
- On success, responds with
CreateDocumentationPartOutput
with field(s):id(Option<String>)
:The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart
is created.location(Option<DocumentationPartLocation>)
:The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
properties(Option<String>)
:A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g.,
“{ "description": "The API does …" }”
. Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension ofx-amazon-apigateway-documentation
.
- On failure, responds with
SdkError<CreateDocumentationPartError>
source§impl Client
impl Client
sourcepub fn create_documentation_version(
&self
) -> CreateDocumentationVersionFluentBuilder
pub fn create_documentation_version( &self ) -> CreateDocumentationVersionFluentBuilder
Constructs a fluent builder for the CreateDocumentationVersion
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
documentation_version(impl Into<String>)
/set_documentation_version(Option<String>)
:
required: trueThe version identifier of the new snapshot.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: falseThe stage name to be associated with the new documentation snapshot.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description about the new documentation snapshot.
- On success, responds with
CreateDocumentationVersionOutput
with field(s):version(Option<String>)
:The version identifier of the API documentation snapshot.
created_date(Option<DateTime>)
:The date when the API documentation snapshot is created.
description(Option<String>)
:The description of the API documentation snapshot.
- On failure, responds with
SdkError<CreateDocumentationVersionError>
source§impl Client
impl Client
sourcepub fn create_domain_name(&self) -> CreateDomainNameFluentBuilder
pub fn create_domain_name(&self) -> CreateDomainNameFluentBuilder
Constructs a fluent builder for the CreateDomainName
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe name of the DomainName resource.
certificate_name(impl Into<String>)
/set_certificate_name(Option<String>)
:
required: falseThe user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
certificate_body(impl Into<String>)
/set_certificate_body(Option<String>)
:
required: false[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
certificate_private_key(impl Into<String>)
/set_certificate_private_key(Option<String>)
:
required: false[Deprecated] Your edge-optimized endpoint’s domain name certificate’s private key.
certificate_chain(impl Into<String>)
/set_certificate_chain(Option<String>)
:
required: false[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
certificate_arn(impl Into<String>)
/set_certificate_arn(Option<String>)
:
required: falseThe reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.
regional_certificate_name(impl Into<String>)
/set_regional_certificate_name(Option<String>)
:
required: falseThe user-friendly name of the certificate that will be used by regional endpoint for this domain name.
regional_certificate_arn(impl Into<String>)
/set_regional_certificate_arn(Option<String>)
:
required: falseThe reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.
endpoint_configuration(EndpointConfiguration)
/set_endpoint_configuration(Option<EndpointConfiguration>)
:
required: falseThe endpoint configuration of this DomainName showing the endpoint types of the domain name.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters.security_policy(SecurityPolicy)
/set_security_policy(Option<SecurityPolicy>)
:
required: falseThe Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
.mutual_tls_authentication(MutualTlsAuthenticationInput)
/set_mutual_tls_authentication(Option<MutualTlsAuthenticationInput>)
:
required: falseThe mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
ownership_verification_certificate_arn(impl Into<String>)
/set_ownership_verification_certificate_arn(Option<String>)
:
required: falseThe ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
- On success, responds with
CreateDomainNameOutput
with field(s):domain_name(Option<String>)
:The custom domain name as an API host name, for example,
my-api.example.com
.certificate_name(Option<String>)
:The name of the certificate that will be used by edge-optimized endpoint for this domain name.
certificate_arn(Option<String>)
:The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.
certificate_upload_date(Option<DateTime>)
:The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
regional_domain_name(Option<String>)
:The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
regional_hosted_zone_id(Option<String>)
:The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
regional_certificate_name(Option<String>)
:The name of the certificate that will be used for validating the regional domain name.
regional_certificate_arn(Option<String>)
:The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
distribution_domain_name(Option<String>)
:The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
distribution_hosted_zone_id(Option<String>)
:The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.endpoint_configuration(Option<EndpointConfiguration>)
:The endpoint configuration of this DomainName showing the endpoint types of the domain name.
domain_name_status(Option<DomainNameStatus>)
:The status of the DomainName migration. The valid values are
AVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, the domain can be updated.domain_name_status_message(Option<String>)
:An optional text message containing detailed information about status of the DomainName migration.
security_policy(Option<SecurityPolicy>)
:The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
.tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
mutual_tls_authentication(Option<MutualTlsAuthentication>)
:The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
ownership_verification_certificate_arn(Option<String>)
:The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
- On failure, responds with
SdkError<CreateDomainNameError>
source§impl Client
impl Client
sourcepub fn create_model(&self) -> CreateModelFluentBuilder
pub fn create_model(&self) -> CreateModelFluentBuilder
Constructs a fluent builder for the CreateModel
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe RestApi identifier under which the Model will be created.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the model. Must be alphanumeric.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the model.
schema(impl Into<String>)
/set_schema(Option<String>)
:
required: falseThe schema for the model. For
application/json
models, this should be JSON schema draft 4 model. The maximum size of the model is 400 KB.content_type(impl Into<String>)
/set_content_type(Option<String>)
:
required: trueThe content-type for the model.
- On success, responds with
CreateModelOutput
with field(s):id(Option<String>)
:The identifier for the model resource.
name(Option<String>)
:The name of the model. Must be an alphanumeric string.
description(Option<String>)
:The description of the model.
schema(Option<String>)
:The schema for the model. For
application/json
models, this should be JSON schema draft 4 model. Do not include “*/” characters in the description of any properties because such “*/” characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API’s SDK generated by API Gateway to fail.content_type(Option<String>)
:The content-type for the model.
- On failure, responds with
SdkError<CreateModelError>
source§impl Client
impl Client
sourcepub fn create_request_validator(&self) -> CreateRequestValidatorFluentBuilder
pub fn create_request_validator(&self) -> CreateRequestValidatorFluentBuilder
Constructs a fluent builder for the CreateRequestValidator
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the to-be-created RequestValidator.
validate_request_body(bool)
/set_validate_request_body(Option<bool>)
:
required: falseA Boolean flag to indicate whether to validate request body according to the configured model schema for the method (
true
) or not (false
).validate_request_parameters(bool)
/set_validate_request_parameters(Option<bool>)
:
required: falseA Boolean flag to indicate whether to validate request parameters,
true
, or notfalse
.
- On success, responds with
CreateRequestValidatorOutput
with field(s):id(Option<String>)
:The identifier of this RequestValidator.
name(Option<String>)
:The name of this RequestValidator
validate_request_body(bool)
:A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
validate_request_parameters(bool)
:A Boolean flag to indicate whether to validate request parameters (
true
) or not (false
).
- On failure, responds with
SdkError<CreateRequestValidatorError>
source§impl Client
impl Client
sourcepub fn create_resource(&self) -> CreateResourceFluentBuilder
pub fn create_resource(&self) -> CreateResourceFluentBuilder
Constructs a fluent builder for the CreateResource
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
parent_id(impl Into<String>)
/set_parent_id(Option<String>)
:
required: trueThe parent resource’s identifier.
path_part(impl Into<String>)
/set_path_part(Option<String>)
:
required: trueThe last path segment for this resource.
- On success, responds with
CreateResourceOutput
with field(s):id(Option<String>)
:The resource’s identifier.
parent_id(Option<String>)
:The parent resource’s identifier.
path_part(Option<String>)
:The last path segment for this resource.
path(Option<String>)
:The full path for this resource.
resource_methods(Option<HashMap::<String, Method>>)
:Gets an API resource’s method of a given HTTP verb.
- On failure, responds with
SdkError<CreateResourceError>
source§impl Client
impl Client
sourcepub fn create_rest_api(&self) -> CreateRestApiFluentBuilder
pub fn create_rest_api(&self) -> CreateRestApiFluentBuilder
Constructs a fluent builder for the CreateRestApi
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the RestApi.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the RestApi.
version(impl Into<String>)
/set_version(Option<String>)
:
required: falseA version identifier for the API.
clone_from(impl Into<String>)
/set_clone_from(Option<String>)
:
required: falseThe ID of the RestApi that you want to clone from.
binary_media_types(impl Into<String>)
/set_binary_media_types(Option<Vec::<String>>)
:
required: falseThe list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
minimum_compression_size(i32)
/set_minimum_compression_size(Option<i32>)
:
required: falseA nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
api_key_source(ApiKeySourceType)
/set_api_key_source(Option<ApiKeySourceType>)
:
required: falseThe source of the API key for metering requests according to a usage plan. Valid values are:
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.endpoint_configuration(EndpointConfiguration)
/set_endpoint_configuration(Option<EndpointConfiguration>)
:
required: falseThe endpoint configuration of this RestApi showing the endpoint types of the API.
policy(impl Into<String>)
/set_policy(Option<String>)
:
required: falseA stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters.disable_execute_api_endpoint(bool)
/set_disable_execute_api_endpoint(Option<bool>)
:
required: falseSpecifies whether clients can invoke your API by using the default
execute-api
endpoint. By default, clients can invoke your API with the defaulthttps://{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
- On success, responds with
CreateRestApiOutput
with field(s):id(Option<String>)
:The API’s identifier. This identifier is unique across all of your APIs in API Gateway.
name(Option<String>)
:The API’s name.
description(Option<String>)
:The API’s description.
created_date(Option<DateTime>)
:The timestamp when the API was created.
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.binary_media_types(Option<Vec::<String>>)
:The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
minimum_compression_size(Option<i32>)
:A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
api_key_source(Option<ApiKeySourceType>)
:The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.endpoint_configuration(Option<EndpointConfiguration>)
:The endpoint configuration of this RestApi showing the endpoint types of the API.
policy(Option<String>)
:A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
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 defaulthttps://{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.root_resource_id(Option<String>)
:The API’s root resource ID.
- On failure, responds with
SdkError<CreateRestApiError>
source§impl Client
impl Client
sourcepub fn create_stage(&self) -> CreateStageFluentBuilder
pub fn create_stage(&self) -> CreateStageFluentBuilder
Constructs a fluent builder for the CreateStage
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe identifier of the Deployment resource for the Stage resource.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the Stage resource.
cache_cluster_enabled(bool)
/set_cache_cluster_enabled(Option<bool>)
:
required: falseWhether cache clustering is enabled for the stage.
cache_cluster_size(CacheClusterSize)
/set_cache_cluster_size(Option<CacheClusterSize>)
:
required: falseThe stage’s cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
variables(impl Into<String>, impl Into<String>)
/set_variables(Option<HashMap::<String, String>>)
:
required: falseA map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match
[A-Za-z0-9-._~:/?#&=,]+
.documentation_version(impl Into<String>)
/set_documentation_version(Option<String>)
:
required: falseThe version of the associated API documentation.
canary_settings(CanarySettings)
/set_canary_settings(Option<CanarySettings>)
:
required: falseThe canary deployment settings of this stage.
tracing_enabled(bool)
/set_tracing_enabled(Option<bool>)
:
required: falseSpecifies whether active tracing with X-ray is enabled for the Stage.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters.
- On success, responds with
CreateStageOutput
with field(s):deployment_id(Option<String>)
:The identifier of the Deployment that the stage points to.
client_certificate_id(Option<String>)
:The identifier of a client certificate for an API stage.
stage_name(Option<String>)
:The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
description(Option<String>)
:The stage’s description.
cache_cluster_enabled(bool)
:Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
totrue
for a method.cache_cluster_size(Option<CacheClusterSize>)
:The stage’s cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
cache_cluster_status(Option<CacheClusterStatus>)
:The status of the cache cluster for the stage, if enabled.
method_settings(Option<HashMap::<String, MethodSetting>>)
:A map that defines the method settings for a Stage resource. Keys (designated as
/{method_setting_key
below) are method paths defined as{resource_path}/{http_method}
for an individual method override, or/*/*
for overriding all methods in the stage.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-._~:/?#&=,]+
.documentation_version(Option<String>)
:The version of the associated API documentation.
access_log_settings(Option<AccessLogSettings>)
:Settings for logging access in this stage.
canary_settings(Option<CanarySettings>)
:Settings for the canary deployment in this stage.
tracing_enabled(bool)
:Specifies whether active tracing with X-ray is enabled for the Stage.
web_acl_arn(Option<String>)
:The ARN of the WebAcl associated with the Stage.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
created_date(Option<DateTime>)
:The timestamp when the stage was created.
last_updated_date(Option<DateTime>)
:The timestamp when the stage last updated.
- On failure, responds with
SdkError<CreateStageError>
source§impl Client
impl Client
sourcepub fn create_usage_plan(&self) -> CreateUsagePlanFluentBuilder
pub fn create_usage_plan(&self) -> CreateUsagePlanFluentBuilder
Constructs a fluent builder for the CreateUsagePlan
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the usage plan.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the usage plan.
api_stages(ApiStage)
/set_api_stages(Option<Vec::<ApiStage>>)
:
required: falseThe associated API stages of the usage plan.
throttle(ThrottleSettings)
/set_throttle(Option<ThrottleSettings>)
:
required: falseThe throttling limits of the usage plan.
quota(QuotaSettings)
/set_quota(Option<QuotaSettings>)
:
required: falseThe quota of the usage plan.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters.
- On success, responds with
CreateUsagePlanOutput
with field(s):id(Option<String>)
:The identifier of a UsagePlan resource.
name(Option<String>)
:The name of a usage plan.
description(Option<String>)
:The description of a usage plan.
api_stages(Option<Vec::<ApiStage>>)
:The associated API stages of a usage plan.
throttle(Option<ThrottleSettings>)
:A map containing method level throttling information for API stage in a usage plan.
quota(Option<QuotaSettings>)
:The target maximum number of permitted requests per a given unit time interval.
product_code(Option<String>)
:The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<CreateUsagePlanError>
source§impl Client
impl Client
sourcepub fn create_usage_plan_key(&self) -> CreateUsagePlanKeyFluentBuilder
pub fn create_usage_plan_key(&self) -> CreateUsagePlanKeyFluentBuilder
Constructs a fluent builder for the CreateUsagePlanKey
operation.
- The fluent builder is configurable:
usage_plan_id(impl Into<String>)
/set_usage_plan_id(Option<String>)
:
required: trueThe Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.
key_id(impl Into<String>)
/set_key_id(Option<String>)
:
required: trueThe identifier of a UsagePlanKey resource for a plan customer.
key_type(impl Into<String>)
/set_key_type(Option<String>)
:
required: trueThe type of a UsagePlanKey resource for a plan customer.
- On success, responds with
CreateUsagePlanKeyOutput
with field(s):id(Option<String>)
:The Id of a usage plan key.
r#type(Option<String>)
:The type of a usage plan key. Currently, the valid key type is
API_KEY
.value(Option<String>)
:The value of a usage plan key.
name(Option<String>)
:The name of a usage plan key.
- On failure, responds with
SdkError<CreateUsagePlanKeyError>
source§impl Client
impl Client
sourcepub fn create_vpc_link(&self) -> CreateVpcLinkFluentBuilder
pub fn create_vpc_link(&self) -> CreateVpcLinkFluentBuilder
Constructs a fluent builder for the CreateVpcLink
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name used to label and identify the VPC link.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the VPC link.
target_arns(impl Into<String>)
/set_target_arns(Option<Vec::<String>>)
:
required: trueThe ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters.
- On success, responds with
CreateVpcLinkOutput
with field(s):id(Option<String>)
:The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
name(Option<String>)
:The name used to label and identify the VPC link.
description(Option<String>)
:The description of the VPC link.
target_arns(Option<Vec::<String>>)
:The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.
status(Option<VpcLinkStatus>)
:The status of the VPC link. The valid values are
AVAILABLE
,PENDING
,DELETING
, orFAILED
. Deploying an API will wait if the status isPENDING
and will fail if the status isDELETING
.status_message(Option<String>)
:A description about the VPC link status.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<CreateVpcLinkError>
source§impl Client
impl Client
sourcepub fn delete_api_key(&self) -> DeleteApiKeyFluentBuilder
pub fn delete_api_key(&self) -> DeleteApiKeyFluentBuilder
Constructs a fluent builder for the DeleteApiKey
operation.
- The fluent builder is configurable:
api_key(impl Into<String>)
/set_api_key(Option<String>)
:
required: trueThe identifier of the ApiKey resource to be deleted.
- On success, responds with
DeleteApiKeyOutput
- On failure, responds with
SdkError<DeleteApiKeyError>
source§impl Client
impl Client
Constructs a fluent builder for the DeleteAuthorizer
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
authorizer_id(impl Into<String>)
/set_authorizer_id(Option<String>)
:
required: trueThe identifier of the Authorizer resource.
- On success, responds with
DeleteAuthorizerOutput
- On failure, responds with
SdkError<DeleteAuthorizerError>
source§impl Client
impl Client
sourcepub fn delete_base_path_mapping(&self) -> DeleteBasePathMappingFluentBuilder
pub fn delete_base_path_mapping(&self) -> DeleteBasePathMappingFluentBuilder
Constructs a fluent builder for the DeleteBasePathMapping
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name of the BasePathMapping resource to delete.
base_path(impl Into<String>)
/set_base_path(Option<String>)
:
required: trueThe base path name of the BasePathMapping resource to delete.
To specify an empty base path, set this parameter to
‘(none)’
.
- On success, responds with
DeleteBasePathMappingOutput
- On failure, responds with
SdkError<DeleteBasePathMappingError>
source§impl Client
impl Client
sourcepub fn delete_client_certificate(&self) -> DeleteClientCertificateFluentBuilder
pub fn delete_client_certificate(&self) -> DeleteClientCertificateFluentBuilder
Constructs a fluent builder for the DeleteClientCertificate
operation.
- The fluent builder is configurable:
client_certificate_id(impl Into<String>)
/set_client_certificate_id(Option<String>)
:
required: trueThe identifier of the ClientCertificate resource to be deleted.
- On success, responds with
DeleteClientCertificateOutput
- On failure, responds with
SdkError<DeleteClientCertificateError>
source§impl Client
impl Client
sourcepub fn delete_deployment(&self) -> DeleteDeploymentFluentBuilder
pub fn delete_deployment(&self) -> DeleteDeploymentFluentBuilder
Constructs a fluent builder for the DeleteDeployment
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe identifier of the Deployment resource to delete.
- On success, responds with
DeleteDeploymentOutput
- On failure, responds with
SdkError<DeleteDeploymentError>
source§impl Client
impl Client
sourcepub fn delete_documentation_part(&self) -> DeleteDocumentationPartFluentBuilder
pub fn delete_documentation_part(&self) -> DeleteDocumentationPartFluentBuilder
Constructs a fluent builder for the DeleteDocumentationPart
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
documentation_part_id(impl Into<String>)
/set_documentation_part_id(Option<String>)
:
required: trueThe identifier of the to-be-deleted documentation part.
- On success, responds with
DeleteDocumentationPartOutput
- On failure, responds with
SdkError<DeleteDocumentationPartError>
source§impl Client
impl Client
sourcepub fn delete_documentation_version(
&self
) -> DeleteDocumentationVersionFluentBuilder
pub fn delete_documentation_version( &self ) -> DeleteDocumentationVersionFluentBuilder
Constructs a fluent builder for the DeleteDocumentationVersion
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
documentation_version(impl Into<String>)
/set_documentation_version(Option<String>)
:
required: trueThe version identifier of a to-be-deleted documentation snapshot.
- On success, responds with
DeleteDocumentationVersionOutput
- On failure, responds with
SdkError<DeleteDocumentationVersionError>
source§impl Client
impl Client
sourcepub fn delete_domain_name(&self) -> DeleteDomainNameFluentBuilder
pub fn delete_domain_name(&self) -> DeleteDomainNameFluentBuilder
Constructs a fluent builder for the DeleteDomainName
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe name of the DomainName resource to be deleted.
- On success, responds with
DeleteDomainNameOutput
- On failure, responds with
SdkError<DeleteDomainNameError>
source§impl Client
impl Client
sourcepub fn delete_gateway_response(&self) -> DeleteGatewayResponseFluentBuilder
pub fn delete_gateway_response(&self) -> DeleteGatewayResponseFluentBuilder
Constructs a fluent builder for the DeleteGatewayResponse
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
response_type(GatewayResponseType)
/set_response_type(Option<GatewayResponseType>)
:
required: trueThe response type of the associated GatewayResponse.
- On success, responds with
DeleteGatewayResponseOutput
- On failure, responds with
SdkError<DeleteGatewayResponseError>
source§impl Client
impl Client
sourcepub fn delete_integration(&self) -> DeleteIntegrationFluentBuilder
pub fn delete_integration(&self) -> DeleteIntegrationFluentBuilder
Constructs a fluent builder for the DeleteIntegration
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueSpecifies a delete integration request’s resource identifier.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueSpecifies a delete integration request’s HTTP method.
- On success, responds with
DeleteIntegrationOutput
- On failure, responds with
SdkError<DeleteIntegrationError>
source§impl Client
impl Client
sourcepub fn delete_integration_response(
&self
) -> DeleteIntegrationResponseFluentBuilder
pub fn delete_integration_response( &self ) -> DeleteIntegrationResponseFluentBuilder
Constructs a fluent builder for the DeleteIntegrationResponse
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueSpecifies a delete integration response request’s resource identifier.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueSpecifies a delete integration response request’s HTTP method.
status_code(impl Into<String>)
/set_status_code(Option<String>)
:
required: trueSpecifies a delete integration response request’s status code.
- On success, responds with
DeleteIntegrationResponseOutput
- On failure, responds with
SdkError<DeleteIntegrationResponseError>
source§impl Client
impl Client
sourcepub fn delete_method(&self) -> DeleteMethodFluentBuilder
pub fn delete_method(&self) -> DeleteMethodFluentBuilder
Constructs a fluent builder for the DeleteMethod
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe Resource identifier for the Method resource.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueThe HTTP verb of the Method resource.
- On success, responds with
DeleteMethodOutput
- On failure, responds with
SdkError<DeleteMethodError>
source§impl Client
impl Client
sourcepub fn delete_method_response(&self) -> DeleteMethodResponseFluentBuilder
pub fn delete_method_response(&self) -> DeleteMethodResponseFluentBuilder
Constructs a fluent builder for the DeleteMethodResponse
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe Resource identifier for the MethodResponse resource.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueThe HTTP verb of the Method resource.
status_code(impl Into<String>)
/set_status_code(Option<String>)
:
required: trueThe status code identifier for the MethodResponse resource.
- On success, responds with
DeleteMethodResponseOutput
- On failure, responds with
SdkError<DeleteMethodResponseError>
source§impl Client
impl Client
sourcepub fn delete_model(&self) -> DeleteModelFluentBuilder
pub fn delete_model(&self) -> DeleteModelFluentBuilder
Constructs a fluent builder for the DeleteModel
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
model_name(impl Into<String>)
/set_model_name(Option<String>)
:
required: trueThe name of the model to delete.
- On success, responds with
DeleteModelOutput
- On failure, responds with
SdkError<DeleteModelError>
source§impl Client
impl Client
sourcepub fn delete_request_validator(&self) -> DeleteRequestValidatorFluentBuilder
pub fn delete_request_validator(&self) -> DeleteRequestValidatorFluentBuilder
Constructs a fluent builder for the DeleteRequestValidator
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
request_validator_id(impl Into<String>)
/set_request_validator_id(Option<String>)
:
required: trueThe identifier of the RequestValidator to be deleted.
- On success, responds with
DeleteRequestValidatorOutput
- On failure, responds with
SdkError<DeleteRequestValidatorError>
source§impl Client
impl Client
sourcepub fn delete_resource(&self) -> DeleteResourceFluentBuilder
pub fn delete_resource(&self) -> DeleteResourceFluentBuilder
Constructs a fluent builder for the DeleteResource
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe identifier of the Resource resource.
- On success, responds with
DeleteResourceOutput
- On failure, responds with
SdkError<DeleteResourceError>
source§impl Client
impl Client
sourcepub fn delete_rest_api(&self) -> DeleteRestApiFluentBuilder
pub fn delete_rest_api(&self) -> DeleteRestApiFluentBuilder
Constructs a fluent builder for the DeleteRestApi
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
- On success, responds with
DeleteRestApiOutput
- On failure, responds with
SdkError<DeleteRestApiError>
source§impl Client
impl Client
sourcepub fn delete_stage(&self) -> DeleteStageFluentBuilder
pub fn delete_stage(&self) -> DeleteStageFluentBuilder
Constructs a fluent builder for the DeleteStage
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe name of the Stage resource to delete.
- On success, responds with
DeleteStageOutput
- On failure, responds with
SdkError<DeleteStageError>
source§impl Client
impl Client
sourcepub fn delete_usage_plan(&self) -> DeleteUsagePlanFluentBuilder
pub fn delete_usage_plan(&self) -> DeleteUsagePlanFluentBuilder
Constructs a fluent builder for the DeleteUsagePlan
operation.
- The fluent builder is configurable:
usage_plan_id(impl Into<String>)
/set_usage_plan_id(Option<String>)
:
required: trueThe Id of the to-be-deleted usage plan.
- On success, responds with
DeleteUsagePlanOutput
- On failure, responds with
SdkError<DeleteUsagePlanError>
source§impl Client
impl Client
sourcepub fn delete_usage_plan_key(&self) -> DeleteUsagePlanKeyFluentBuilder
pub fn delete_usage_plan_key(&self) -> DeleteUsagePlanKeyFluentBuilder
Constructs a fluent builder for the DeleteUsagePlanKey
operation.
- The fluent builder is configurable:
usage_plan_id(impl Into<String>)
/set_usage_plan_id(Option<String>)
:
required: trueThe Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
key_id(impl Into<String>)
/set_key_id(Option<String>)
:
required: trueThe Id of the UsagePlanKey resource to be deleted.
- On success, responds with
DeleteUsagePlanKeyOutput
- On failure, responds with
SdkError<DeleteUsagePlanKeyError>
source§impl Client
impl Client
sourcepub fn delete_vpc_link(&self) -> DeleteVpcLinkFluentBuilder
pub fn delete_vpc_link(&self) -> DeleteVpcLinkFluentBuilder
Constructs a fluent builder for the DeleteVpcLink
operation.
- The fluent builder is configurable:
vpc_link_id(impl Into<String>)
/set_vpc_link_id(Option<String>)
:
required: trueThe identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
- On success, responds with
DeleteVpcLinkOutput
- On failure, responds with
SdkError<DeleteVpcLinkError>
source§impl Client
impl Client
Constructs a fluent builder for the FlushStageAuthorizersCache
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe name of the stage to flush.
- On success, responds with
FlushStageAuthorizersCacheOutput
- On failure, responds with
SdkError<FlushStageAuthorizersCacheError>
source§impl Client
impl Client
sourcepub fn flush_stage_cache(&self) -> FlushStageCacheFluentBuilder
pub fn flush_stage_cache(&self) -> FlushStageCacheFluentBuilder
Constructs a fluent builder for the FlushStageCache
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe name of the stage to flush its cache.
- On success, responds with
FlushStageCacheOutput
- On failure, responds with
SdkError<FlushStageCacheError>
source§impl Client
impl Client
sourcepub fn generate_client_certificate(
&self
) -> GenerateClientCertificateFluentBuilder
pub fn generate_client_certificate( &self ) -> GenerateClientCertificateFluentBuilder
Constructs a fluent builder for the GenerateClientCertificate
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the ClientCertificate.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters.
- On success, responds with
GenerateClientCertificateOutput
with field(s):client_certificate_id(Option<String>)
:The identifier of the client certificate.
description(Option<String>)
:The description of the client certificate.
pem_encoded_certificate(Option<String>)
:The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
created_date(Option<DateTime>)
:The timestamp when the client certificate was created.
expiration_date(Option<DateTime>)
:The timestamp when the client certificate will expire.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<GenerateClientCertificateError>
source§impl Client
impl Client
sourcepub fn get_account(&self) -> GetAccountFluentBuilder
pub fn get_account(&self) -> GetAccountFluentBuilder
Constructs a fluent builder for the GetAccount
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetAccountOutput
with field(s):cloudwatch_role_arn(Option<String>)
:The ARN of an Amazon CloudWatch role for the current Account.
throttle_settings(Option<ThrottleSettings>)
:Specifies the API request limits configured for the current Account.
features(Option<Vec::<String>>)
:A list of features supported for the account. When usage plans are enabled, the features list will include an entry of
“UsagePlans”
.api_key_version(Option<String>)
:The version of the API keys used for the account.
- On failure, responds with
SdkError<GetAccountError>
source§impl Client
impl Client
sourcepub fn get_api_key(&self) -> GetApiKeyFluentBuilder
pub fn get_api_key(&self) -> GetApiKeyFluentBuilder
Constructs a fluent builder for the GetApiKey
operation.
- The fluent builder is configurable:
api_key(impl Into<String>)
/set_api_key(Option<String>)
:
required: trueThe identifier of the ApiKey resource.
include_value(bool)
/set_include_value(Option<bool>)
:
required: falseA boolean flag to specify whether (
true
) or not (false
) the result contains the key value.
- On success, responds with
GetApiKeyOutput
with field(s):id(Option<String>)
:The identifier of the API Key.
value(Option<String>)
:The value of the API Key.
name(Option<String>)
:The name of the API Key.
customer_id(Option<String>)
:An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
description(Option<String>)
:The description of the API Key.
enabled(bool)
:Specifies whether the API Key can be used by callers.
created_date(Option<DateTime>)
:The timestamp when the API Key was created.
last_updated_date(Option<DateTime>)
:The timestamp when the API Key was last updated.
stage_keys(Option<Vec::<String>>)
:A list of Stage resources that are associated with the ApiKey resource.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<GetApiKeyError>
source§impl Client
impl Client
sourcepub fn get_api_keys(&self) -> GetApiKeysFluentBuilder
pub fn get_api_keys(&self) -> GetApiKeysFluentBuilder
Constructs a fluent builder for the GetApiKeys
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
name_query(impl Into<String>)
/set_name_query(Option<String>)
:
required: falseThe name of queried API keys.
customer_id(impl Into<String>)
/set_customer_id(Option<String>)
:
required: falseThe identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.
include_values(bool)
/set_include_values(Option<bool>)
:
required: falseA boolean flag to specify whether (
true
) or not (false
) the result contains key values.
- On success, responds with
GetApiKeysOutput
with field(s):warnings(Option<Vec::<String>>)
:A list of warning messages logged during the import of API keys when the
failOnWarnings
option is set to true.items(Option<Vec::<ApiKey>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetApiKeysError>
source§impl Client
impl Client
Constructs a fluent builder for the GetAuthorizer
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
authorizer_id(impl Into<String>)
/set_authorizer_id(Option<String>)
:
required: trueThe identifier of the Authorizer resource.
- On success, responds with
GetAuthorizerOutput
with field(s):id(Option<String>)
:The identifier for the authorizer resource.
name(Option<String>)
:The name of the authorizer.
r#type(Option<AuthorizerType>)
:The authorizer type. Valid values are
TOKEN
for a Lambda function using a single authorization token submitted in a custom header,REQUEST
for a Lambda function using incoming request parameters, andCOGNITO_USER_POOLS
for using an Amazon Cognito user pool.provider_arns(Option<Vec::<String>>)
:A list of the Amazon Cognito user pool ARNs for the
COGNITO_USER_POOLS
authorizer. Each element is of this format:arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}
. For aTOKEN
orREQUEST
authorizer, this is not defined.auth_type(Option<String>)
:Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
authorizer_uri(Option<String>)
:Specifies the authorizer’s Uniform Resource Identifier (URI). For
TOKEN
orREQUEST
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 formarn: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
.authorizer_credentials(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, specify null.
identity_source(Option<String>)
:The identity source for which authorization is requested. For a
TOKEN
orCOGNITO_USER_POOLS
authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name isAuth
, the header mapping expression ismethod.request.header.Auth
. For theREQUEST
authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if anAuth
header, aName
query string parameter are defined as identity sources, this value ismethod.request.header.Auth
,method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.identity_validation_expression(Option<String>)
:A validation expression for the incoming identity token. For
TOKEN
authorizers, this value is a regular expression. ForCOGNITO_USER_POOLS
authorizers, API Gateway will match theaud
field of the incoming token from the client against the specified regular expression. It will invoke the authorizer’s Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to theREQUEST
authorizer.authorizer_result_ttl_in_seconds(Option<i32>)
:The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- On failure, responds with
SdkError<GetAuthorizerError>
source§impl Client
impl Client
Constructs a fluent builder for the GetAuthorizers
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetAuthorizersOutput
with field(s):items(Option<Vec::<Authorizer>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetAuthorizersError>
source§impl Client
impl Client
sourcepub fn get_base_path_mapping(&self) -> GetBasePathMappingFluentBuilder
pub fn get_base_path_mapping(&self) -> GetBasePathMappingFluentBuilder
Constructs a fluent builder for the GetBasePathMapping
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name of the BasePathMapping resource to be described.
base_path(impl Into<String>)
/set_base_path(Option<String>)
:
required: trueThe base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify ‘(none)’ if you do not want callers to specify any base path name after the domain name.
- On success, responds with
GetBasePathMappingOutput
with field(s):base_path(Option<String>)
:The base path name that callers of the API must provide as part of the URL after the domain name.
rest_api_id(Option<String>)
:The string identifier of the associated RestApi.
stage(Option<String>)
:The name of the associated stage.
- On failure, responds with
SdkError<GetBasePathMappingError>
source§impl Client
impl Client
sourcepub fn get_base_path_mappings(&self) -> GetBasePathMappingsFluentBuilder
pub fn get_base_path_mappings(&self) -> GetBasePathMappingsFluentBuilder
Constructs a fluent builder for the GetBasePathMappings
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name of a BasePathMapping resource.
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetBasePathMappingsOutput
with field(s):items(Option<Vec::<BasePathMapping>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetBasePathMappingsError>
source§impl Client
impl Client
sourcepub fn get_client_certificate(&self) -> GetClientCertificateFluentBuilder
pub fn get_client_certificate(&self) -> GetClientCertificateFluentBuilder
Constructs a fluent builder for the GetClientCertificate
operation.
- The fluent builder is configurable:
client_certificate_id(impl Into<String>)
/set_client_certificate_id(Option<String>)
:
required: trueThe identifier of the ClientCertificate resource to be described.
- On success, responds with
GetClientCertificateOutput
with field(s):client_certificate_id(Option<String>)
:The identifier of the client certificate.
description(Option<String>)
:The description of the client certificate.
pem_encoded_certificate(Option<String>)
:The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
created_date(Option<DateTime>)
:The timestamp when the client certificate was created.
expiration_date(Option<DateTime>)
:The timestamp when the client certificate will expire.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<GetClientCertificateError>
source§impl Client
impl Client
sourcepub fn get_client_certificates(&self) -> GetClientCertificatesFluentBuilder
pub fn get_client_certificates(&self) -> GetClientCertificatesFluentBuilder
Constructs a fluent builder for the GetClientCertificates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetClientCertificatesOutput
with field(s):items(Option<Vec::<ClientCertificate>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetClientCertificatesError>
source§impl Client
impl Client
sourcepub fn get_deployment(&self) -> GetDeploymentFluentBuilder
pub fn get_deployment(&self) -> GetDeploymentFluentBuilder
Constructs a fluent builder for the GetDeployment
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe identifier of the Deployment resource to get information about.
embed(impl Into<String>)
/set_embed(Option<Vec::<String>>)
:
required: falseA query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this
embed
parameter value is a list of comma-separated strings, as inGET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2
. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the“apisummary”
string. For example,GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary
.
- On success, responds with
GetDeploymentOutput
with field(s):id(Option<String>)
:The identifier for the deployment resource.
description(Option<String>)
:The description for the deployment resource.
created_date(Option<DateTime>)
:The date and time that the deployment resource was created.
api_summary(Option<HashMap::<String, HashMap::<String, MethodSnapshot>>>)
:A summary of the RestApi at the date and time that the deployment resource was created.
- On failure, responds with
SdkError<GetDeploymentError>
source§impl Client
impl Client
sourcepub fn get_deployments(&self) -> GetDeploymentsFluentBuilder
pub fn get_deployments(&self) -> GetDeploymentsFluentBuilder
Constructs a fluent builder for the GetDeployments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetDeploymentsOutput
with field(s):items(Option<Vec::<Deployment>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetDeploymentsError>
source§impl Client
impl Client
sourcepub fn get_documentation_part(&self) -> GetDocumentationPartFluentBuilder
pub fn get_documentation_part(&self) -> GetDocumentationPartFluentBuilder
Constructs a fluent builder for the GetDocumentationPart
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
documentation_part_id(impl Into<String>)
/set_documentation_part_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
- On success, responds with
GetDocumentationPartOutput
with field(s):id(Option<String>)
:The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart
is created.location(Option<DocumentationPartLocation>)
:The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
properties(Option<String>)
:A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g.,
“{ "description": "The API does …" }”
. Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension ofx-amazon-apigateway-documentation
.
- On failure, responds with
SdkError<GetDocumentationPartError>
source§impl Client
impl Client
sourcepub fn get_documentation_parts(&self) -> GetDocumentationPartsFluentBuilder
pub fn get_documentation_parts(&self) -> GetDocumentationPartsFluentBuilder
Constructs a fluent builder for the GetDocumentationParts
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
r#type(DocumentationPartType)
/set_type(Option<DocumentationPartType>)
:
required: falseThe type of API entities of the to-be-retrieved documentation parts.
name_query(impl Into<String>)
/set_name_query(Option<String>)
:
required: falseThe name of API entities of the to-be-retrieved documentation parts.
path(impl Into<String>)
/set_path(Option<String>)
:
required: falseThe path of API entities of the to-be-retrieved documentation parts.
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
location_status(LocationStatusType)
/set_location_status(Option<LocationStatusType>)
:
required: falseThe status of the API documentation parts to retrieve. Valid values are
DOCUMENTED
for retrieving DocumentationPart resources with content andUNDOCUMENTED
for DocumentationPart resources without content.
- On success, responds with
GetDocumentationPartsOutput
with field(s):items(Option<Vec::<DocumentationPart>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetDocumentationPartsError>
source§impl Client
impl Client
sourcepub fn get_documentation_version(&self) -> GetDocumentationVersionFluentBuilder
pub fn get_documentation_version(&self) -> GetDocumentationVersionFluentBuilder
Constructs a fluent builder for the GetDocumentationVersion
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
documentation_version(impl Into<String>)
/set_documentation_version(Option<String>)
:
required: trueThe version identifier of the to-be-retrieved documentation snapshot.
- On success, responds with
GetDocumentationVersionOutput
with field(s):version(Option<String>)
:The version identifier of the API documentation snapshot.
created_date(Option<DateTime>)
:The date when the API documentation snapshot is created.
description(Option<String>)
:The description of the API documentation snapshot.
- On failure, responds with
SdkError<GetDocumentationVersionError>
source§impl Client
impl Client
sourcepub fn get_documentation_versions(
&self
) -> GetDocumentationVersionsFluentBuilder
pub fn get_documentation_versions( &self ) -> GetDocumentationVersionsFluentBuilder
Constructs a fluent builder for the GetDocumentationVersions
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetDocumentationVersionsOutput
with field(s):items(Option<Vec::<DocumentationVersion>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetDocumentationVersionsError>
source§impl Client
impl Client
sourcepub fn get_domain_name(&self) -> GetDomainNameFluentBuilder
pub fn get_domain_name(&self) -> GetDomainNameFluentBuilder
Constructs a fluent builder for the GetDomainName
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe name of the DomainName resource.
- On success, responds with
GetDomainNameOutput
with field(s):domain_name(Option<String>)
:The custom domain name as an API host name, for example,
my-api.example.com
.certificate_name(Option<String>)
:The name of the certificate that will be used by edge-optimized endpoint for this domain name.
certificate_arn(Option<String>)
:The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.
certificate_upload_date(Option<DateTime>)
:The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
regional_domain_name(Option<String>)
:The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
regional_hosted_zone_id(Option<String>)
:The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
regional_certificate_name(Option<String>)
:The name of the certificate that will be used for validating the regional domain name.
regional_certificate_arn(Option<String>)
:The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
distribution_domain_name(Option<String>)
:The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
distribution_hosted_zone_id(Option<String>)
:The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.endpoint_configuration(Option<EndpointConfiguration>)
:The endpoint configuration of this DomainName showing the endpoint types of the domain name.
domain_name_status(Option<DomainNameStatus>)
:The status of the DomainName migration. The valid values are
AVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, the domain can be updated.domain_name_status_message(Option<String>)
:An optional text message containing detailed information about status of the DomainName migration.
security_policy(Option<SecurityPolicy>)
:The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
.tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
mutual_tls_authentication(Option<MutualTlsAuthentication>)
:The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
ownership_verification_certificate_arn(Option<String>)
:The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
- On failure, responds with
SdkError<GetDomainNameError>
source§impl Client
impl Client
sourcepub fn get_domain_names(&self) -> GetDomainNamesFluentBuilder
pub fn get_domain_names(&self) -> GetDomainNamesFluentBuilder
Constructs a fluent builder for the GetDomainNames
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetDomainNamesOutput
with field(s):items(Option<Vec::<DomainName>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetDomainNamesError>
source§impl Client
impl Client
sourcepub fn get_export(&self) -> GetExportFluentBuilder
pub fn get_export(&self) -> GetExportFluentBuilder
Constructs a fluent builder for the GetExport
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe name of the Stage that will be exported.
export_type(impl Into<String>)
/set_export_type(Option<String>)
:
required: trueThe type of export. Acceptable values are ‘oas30’ for OpenAPI 3.0.x and ‘swagger’ for Swagger/OpenAPI 2.0.
parameters(impl Into<String>, impl Into<String>)
/set_parameters(Option<HashMap::<String, String>>)
:
required: falseA key-value map of query string parameters that specify properties of the export, depending on the requested
exportType
. ForexportType
oas30
andswagger
, any combination of the following parameters are supported:extensions=‘integrations’
orextensions=‘apigateway’
will export the API with x-amazon-apigateway-integration extensions.extensions=‘authorizers’
will export the API with x-amazon-apigateway-authorizer extensions.postman
will export the API with Postman extensions, allowing for import to the Postman toolaccepts(impl Into<String>)
/set_accepts(Option<String>)
:
required: falseThe content-type of the export, for example
application/json
. Currentlyapplication/json
andapplication/yaml
are supported forexportType
ofoas30
andswagger
. This should be specified in theAccept
header for direct API requests.
- On success, responds with
GetExportOutput
with field(s):content_type(Option<String>)
:The content-type header value in the HTTP response. This will correspond to a valid ‘accept’ type in the request.
content_disposition(Option<String>)
:The content-disposition header value in the HTTP response.
body(Option<Blob>)
:The binary blob response to GetExport, which contains the export.
- On failure, responds with
SdkError<GetExportError>
source§impl Client
impl Client
sourcepub fn get_gateway_response(&self) -> GetGatewayResponseFluentBuilder
pub fn get_gateway_response(&self) -> GetGatewayResponseFluentBuilder
Constructs a fluent builder for the GetGatewayResponse
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
response_type(GatewayResponseType)
/set_response_type(Option<GatewayResponseType>)
:
required: trueThe response type of the associated GatewayResponse.
- On success, responds with
GetGatewayResponseOutput
with field(s):response_type(Option<GatewayResponseType>)
:The response type of the associated GatewayResponse.
status_code(Option<String>)
:The HTTP status code for this GatewayResponse.
response_parameters(Option<HashMap::<String, String>>)
:Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
response_templates(Option<HashMap::<String, String>>)
:Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
default_response(bool)
:A Boolean flag to indicate whether this GatewayResponse is the default gateway response (
true
) or not (false
). A default gateway response is one generated by API Gateway without any customization by an API developer.
- On failure, responds with
SdkError<GetGatewayResponseError>
source§impl Client
impl Client
sourcepub fn get_gateway_responses(&self) -> GetGatewayResponsesFluentBuilder
pub fn get_gateway_responses(&self) -> GetGatewayResponsesFluentBuilder
Constructs a fluent builder for the GetGatewayResponses
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.
- On success, responds with
GetGatewayResponsesOutput
with field(s):items(Option<Vec::<GatewayResponse>>)
:Returns the entire collection, because of no pagination support.
position(Option<String>)
:The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
- On failure, responds with
SdkError<GetGatewayResponsesError>
source§impl Client
impl Client
sourcepub fn get_integration(&self) -> GetIntegrationFluentBuilder
pub fn get_integration(&self) -> GetIntegrationFluentBuilder
Constructs a fluent builder for the GetIntegration
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueSpecifies a get integration request’s resource identifier
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueSpecifies a get integration request’s HTTP method.
- On success, responds with
GetIntegrationOutput
with field(s):r#type(Option<IntegrationType>)
:Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (
http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with aconnectionType
ofVPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.http_method(Option<String>)
:Specifies the integration’s HTTP method type. For the Type property, if you specify
MOCK
, this property is optional. For Lambda integrations, you must set the integration method toPOST
. For all other types, you must specify this property.uri(Option<String>)
:Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For
HTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. IfconnectionType
isVPC_LINK
specify the Network Load Balancer DNS name. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}
. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}… query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
connection_type(Option<ConnectionType>)
:The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.connection_id(Option<String>)
:The ID of the VpcLink used for the integration when
connectionType=VPC_LINK
and undefined, otherwise.credentials(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 Amazon Web Services services, specify null.request_parameters(Option<HashMap::<String, String>>)
:A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of
method.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.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.
passthrough_behavior(Option<String>)
:Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in
requestTemplates
. The valid value is one of the following:WHEN_NO_MATCH
: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.WHEN_NO_TEMPLATES
: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.NEVER
: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.content_handling(Option<ContentHandlingStrategy>)
:Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the
passthroughBehavior
is configured to support payload pass-through.timeout_in_millis(i32)
:Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
cache_namespace(Option<String>)
:Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources.cache_key_parameters(Option<Vec::<String>>)
:A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
.integration_responses(Option<HashMap::<String, IntegrationResponse>>)
:Specifies the integration’s responses.
tls_config(Option<TlsConfig>)
:Specifies the TLS configuration for an integration.
- On failure, responds with
SdkError<GetIntegrationError>
source§impl Client
impl Client
sourcepub fn get_integration_response(&self) -> GetIntegrationResponseFluentBuilder
pub fn get_integration_response(&self) -> GetIntegrationResponseFluentBuilder
Constructs a fluent builder for the GetIntegrationResponse
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueSpecifies a get integration response request’s resource identifier.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueSpecifies a get integration response request’s HTTP method.
status_code(impl Into<String>)
/set_status_code(Option<String>)
:
required: trueSpecifies a get integration response request’s status code.
- On success, responds with
GetIntegrationResponseOutput
with field(s):status_code(Option<String>)
:Specifies the status code that is used to map the integration response to an existing MethodResponse.
selection_pattern(Option<String>)
:Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the
.+
regex to match error response. However, make sure that the error response does not contain any newline (\n
) character in such cases. If the back end is an Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched.response_parameters(Option<HashMap::<String, String>>)
:A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of
method.response.header.{name}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
is a valid and unique response header name andJSON-expression
is a valid JSON expression without the$
prefix.response_templates(Option<HashMap::<String, String>>)
:Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
content_handling(Option<ContentHandlingStrategy>)
:Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- On failure, responds with
SdkError<GetIntegrationResponseError>
source§impl Client
impl Client
sourcepub fn get_method(&self) -> GetMethodFluentBuilder
pub fn get_method(&self) -> GetMethodFluentBuilder
Constructs a fluent builder for the GetMethod
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe Resource identifier for the Method resource.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueSpecifies the method request’s HTTP method type.
- On success, responds with
GetMethodOutput
with field(s):http_method(Option<String>)
:The method’s HTTP verb.
authorization_type(Option<String>)
:The method’s authorization type. Valid values are
NONE
for open access,AWS_IAM
for using AWS IAM permissions,CUSTOM
for using a custom authorizer, orCOGNITO_USER_POOLS
for using a Cognito user pool.authorizer_id(Option<String>)
:The identifier of an Authorizer to use on this method. The
authorizationType
must beCUSTOM
.api_key_required(Option<bool>)
:A boolean flag specifying whether a valid ApiKey is required to invoke this method.
request_validator_id(Option<String>)
:The identifier of a RequestValidator for request validation.
operation_name(Option<String>)
:A human-friendly operation identifier for the method. For example, you can assign the
operationName
ofListPets
for theGET /pets
method in thePetStore
example.request_parameters(Option<HashMap::<String, bool>>)
:A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of
method.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true
) or optional (false
). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.request_models(Option<HashMap::<String, String>>)
:A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
method_responses(Option<HashMap::<String, MethodResponse>>)
:Gets a method response associated with a given HTTP status code.
method_integration(Option<Integration>)
:Gets the method’s integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
authorization_scopes(Option<Vec::<String>>)
:A list of authorization scopes configured on the method. The scopes are used with a
COGNITO_USER_POOLS
authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- On failure, responds with
SdkError<GetMethodError>
source§impl Client
impl Client
sourcepub fn get_method_response(&self) -> GetMethodResponseFluentBuilder
pub fn get_method_response(&self) -> GetMethodResponseFluentBuilder
Constructs a fluent builder for the GetMethodResponse
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe Resource identifier for the MethodResponse resource.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueThe HTTP verb of the Method resource.
status_code(impl Into<String>)
/set_status_code(Option<String>)
:
required: trueThe status code for the MethodResponse resource.
- On success, responds with
GetMethodResponseOutput
with field(s):status_code(Option<String>)
:The method response’s status code.
response_parameters(Option<HashMap::<String, bool>>)
:A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern
method.response.header.{name}
, wherename
is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API’s IntegrationResponse. The integration response data that can be mapped include an integration response header expressed inintegration.response.header.{name}
, a static value enclosed within a pair of single quotes (e.g.,‘application/json’
), or a JSON expression from the back-end response payload in the form ofintegration.response.body.{JSON-expression}
, whereJSON-expression
is a valid JSON expression without the$
prefix.)response_models(Option<HashMap::<String, String>>)
:Specifies the Model resources used for the response’s content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
- On failure, responds with
SdkError<GetMethodResponseError>
source§impl Client
impl Client
sourcepub fn get_model(&self) -> GetModelFluentBuilder
pub fn get_model(&self) -> GetModelFluentBuilder
Constructs a fluent builder for the GetModel
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe RestApi identifier under which the Model exists.
model_name(impl Into<String>)
/set_model_name(Option<String>)
:
required: trueThe name of the model as an identifier.
flatten(bool)
/set_flatten(Option<bool>)
:
required: falseA query parameter of a Boolean value to resolve (
true
) all external model references and returns a flattened model schema or not (false
) The default isfalse
.
- On success, responds with
GetModelOutput
with field(s):id(Option<String>)
:The identifier for the model resource.
name(Option<String>)
:The name of the model. Must be an alphanumeric string.
description(Option<String>)
:The description of the model.
schema(Option<String>)
:The schema for the model. For
application/json
models, this should be JSON schema draft 4 model. Do not include “*/” characters in the description of any properties because such “*/” characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API’s SDK generated by API Gateway to fail.content_type(Option<String>)
:The content-type for the model.
- On failure, responds with
SdkError<GetModelError>
source§impl Client
impl Client
sourcepub fn get_model_template(&self) -> GetModelTemplateFluentBuilder
pub fn get_model_template(&self) -> GetModelTemplateFluentBuilder
Constructs a fluent builder for the GetModelTemplate
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
model_name(impl Into<String>)
/set_model_name(Option<String>)
:
required: trueThe name of the model for which to generate a template.
- On success, responds with
GetModelTemplateOutput
with field(s):value(Option<String>)
:The Apache Velocity Template Language (VTL) template content used for the template resource.
- On failure, responds with
SdkError<GetModelTemplateError>
source§impl Client
impl Client
sourcepub fn get_models(&self) -> GetModelsFluentBuilder
pub fn get_models(&self) -> GetModelsFluentBuilder
Constructs a fluent builder for the GetModels
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetModelsOutput
with field(s):items(Option<Vec::<Model>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetModelsError>
source§impl Client
impl Client
sourcepub fn get_request_validator(&self) -> GetRequestValidatorFluentBuilder
pub fn get_request_validator(&self) -> GetRequestValidatorFluentBuilder
Constructs a fluent builder for the GetRequestValidator
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
request_validator_id(impl Into<String>)
/set_request_validator_id(Option<String>)
:
required: trueThe identifier of the RequestValidator to be retrieved.
- On success, responds with
GetRequestValidatorOutput
with field(s):id(Option<String>)
:The identifier of this RequestValidator.
name(Option<String>)
:The name of this RequestValidator
validate_request_body(bool)
:A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
validate_request_parameters(bool)
:A Boolean flag to indicate whether to validate request parameters (
true
) or not (false
).
- On failure, responds with
SdkError<GetRequestValidatorError>
source§impl Client
impl Client
sourcepub fn get_request_validators(&self) -> GetRequestValidatorsFluentBuilder
pub fn get_request_validators(&self) -> GetRequestValidatorsFluentBuilder
Constructs a fluent builder for the GetRequestValidators
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetRequestValidatorsOutput
with field(s):items(Option<Vec::<RequestValidator>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetRequestValidatorsError>
source§impl Client
impl Client
sourcepub fn get_resource(&self) -> GetResourceFluentBuilder
pub fn get_resource(&self) -> GetResourceFluentBuilder
Constructs a fluent builder for the GetResource
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe identifier for the Resource resource.
embed(impl Into<String>)
/set_embed(Option<Vec::<String>>)
:
required: falseA query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This
embed
parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the“methods”
string. For example,GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods
.
- On success, responds with
GetResourceOutput
with field(s):id(Option<String>)
:The resource’s identifier.
parent_id(Option<String>)
:The parent resource’s identifier.
path_part(Option<String>)
:The last path segment for this resource.
path(Option<String>)
:The full path for this resource.
resource_methods(Option<HashMap::<String, Method>>)
:Gets an API resource’s method of a given HTTP verb.
- On failure, responds with
SdkError<GetResourceError>
source§impl Client
impl Client
sourcepub fn get_resources(&self) -> GetResourcesFluentBuilder
pub fn get_resources(&self) -> GetResourcesFluentBuilder
Constructs a fluent builder for the GetResources
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
embed(impl Into<String>)
/set_embed(Option<Vec::<String>>)
:
required: falseA query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This
embed
parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the“methods”
string. For example,GET /restapis/{restapi_id}/resources?embed=methods
.
- On success, responds with
GetResourcesOutput
with field(s):items(Option<Vec::<Resource>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetResourcesError>
source§impl Client
impl Client
sourcepub fn get_rest_api(&self) -> GetRestApiFluentBuilder
pub fn get_rest_api(&self) -> GetRestApiFluentBuilder
Constructs a fluent builder for the GetRestApi
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
- On success, responds with
GetRestApiOutput
with field(s):id(Option<String>)
:The API’s identifier. This identifier is unique across all of your APIs in API Gateway.
name(Option<String>)
:The API’s name.
description(Option<String>)
:The API’s description.
created_date(Option<DateTime>)
:The timestamp when the API was created.
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.binary_media_types(Option<Vec::<String>>)
:The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
minimum_compression_size(Option<i32>)
:A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
api_key_source(Option<ApiKeySourceType>)
:The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.endpoint_configuration(Option<EndpointConfiguration>)
:The endpoint configuration of this RestApi showing the endpoint types of the API.
policy(Option<String>)
:A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
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 defaulthttps://{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.root_resource_id(Option<String>)
:The API’s root resource ID.
- On failure, responds with
SdkError<GetRestApiError>
source§impl Client
impl Client
sourcepub fn get_rest_apis(&self) -> GetRestApisFluentBuilder
pub fn get_rest_apis(&self) -> GetRestApisFluentBuilder
Constructs a fluent builder for the GetRestApis
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetRestApisOutput
with field(s):items(Option<Vec::<RestApi>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetRestApisError>
source§impl Client
impl Client
sourcepub fn get_sdk(&self) -> GetSdkFluentBuilder
pub fn get_sdk(&self) -> GetSdkFluentBuilder
Constructs a fluent builder for the GetSdk
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe name of the Stage that the SDK will use.
sdk_type(impl Into<String>)
/set_sdk_type(Option<String>)
:
required: trueThe language for the generated SDK. Currently
java
,javascript
,android
,objectivec
(for iOS),swift
(for iOS), andruby
are supported.parameters(impl Into<String>, impl Into<String>)
/set_parameters(Option<HashMap::<String, String>>)
:
required: falseA string-to-string key-value map of query parameters
sdkType
-dependent properties of the SDK. ForsdkType
ofobjectivec
orswift
, a parameter namedclassPrefix
is required. ForsdkType
ofandroid
, parameters namedgroupId
,artifactId
,artifactVersion
, andinvokerPackage
are required. ForsdkType
ofjava
, parameters namedserviceName
andjavaPackageName
are required.
- On success, responds with
GetSdkOutput
with field(s):content_type(Option<String>)
:The content-type header value in the HTTP response.
content_disposition(Option<String>)
:The content-disposition header value in the HTTP response.
body(Option<Blob>)
:The binary blob response to GetSdk, which contains the generated SDK.
- On failure, responds with
SdkError<GetSdkError>
source§impl Client
impl Client
sourcepub fn get_sdk_type(&self) -> GetSdkTypeFluentBuilder
pub fn get_sdk_type(&self) -> GetSdkTypeFluentBuilder
Constructs a fluent builder for the GetSdkType
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe identifier of the queried SdkType instance.
- On success, responds with
GetSdkTypeOutput
with field(s):id(Option<String>)
:The identifier of an SdkType instance.
friendly_name(Option<String>)
:The user-friendly name of an SdkType instance.
description(Option<String>)
:The description of an SdkType.
configuration_properties(Option<Vec::<SdkConfigurationProperty>>)
:A list of configuration properties of an SdkType.
- On failure, responds with
SdkError<GetSdkTypeError>
source§impl Client
impl Client
sourcepub fn get_sdk_types(&self) -> GetSdkTypesFluentBuilder
pub fn get_sdk_types(&self) -> GetSdkTypesFluentBuilder
Constructs a fluent builder for the GetSdkTypes
operation.
- The fluent builder is configurable:
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetSdkTypesOutput
with field(s):items(Option<Vec::<SdkType>>)
:The current page of elements from this collection.
- On failure, responds with
SdkError<GetSdkTypesError>
source§impl Client
impl Client
sourcepub fn get_stage(&self) -> GetStageFluentBuilder
pub fn get_stage(&self) -> GetStageFluentBuilder
Constructs a fluent builder for the GetStage
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe name of the Stage resource to get information about.
- On success, responds with
GetStageOutput
with field(s):deployment_id(Option<String>)
:The identifier of the Deployment that the stage points to.
client_certificate_id(Option<String>)
:The identifier of a client certificate for an API stage.
stage_name(Option<String>)
:The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
description(Option<String>)
:The stage’s description.
cache_cluster_enabled(bool)
:Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
totrue
for a method.cache_cluster_size(Option<CacheClusterSize>)
:The stage’s cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
cache_cluster_status(Option<CacheClusterStatus>)
:The status of the cache cluster for the stage, if enabled.
method_settings(Option<HashMap::<String, MethodSetting>>)
:A map that defines the method settings for a Stage resource. Keys (designated as
/{method_setting_key
below) are method paths defined as{resource_path}/{http_method}
for an individual method override, or/*/*
for overriding all methods in the stage.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-._~:/?#&=,]+
.documentation_version(Option<String>)
:The version of the associated API documentation.
access_log_settings(Option<AccessLogSettings>)
:Settings for logging access in this stage.
canary_settings(Option<CanarySettings>)
:Settings for the canary deployment in this stage.
tracing_enabled(bool)
:Specifies whether active tracing with X-ray is enabled for the Stage.
web_acl_arn(Option<String>)
:The ARN of the WebAcl associated with the Stage.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
created_date(Option<DateTime>)
:The timestamp when the stage was created.
last_updated_date(Option<DateTime>)
:The timestamp when the stage last updated.
- On failure, responds with
SdkError<GetStageError>
source§impl Client
impl Client
sourcepub fn get_stages(&self) -> GetStagesFluentBuilder
pub fn get_stages(&self) -> GetStagesFluentBuilder
Constructs a fluent builder for the GetStages
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: falseThe stages’ deployment identifiers.
- On success, responds with
GetStagesOutput
with field(s):item(Option<Vec::<Stage>>)
:The current page of elements from this collection.
- On failure, responds with
SdkError<GetStagesError>
source§impl Client
impl Client
Constructs a fluent builder for the GetTags
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of a resource that can be tagged.
position(impl Into<String>)
/set_position(Option<String>)
:
required: false(Not currently supported) The current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: false(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetTagsOutput
with field(s):tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<GetTagsError>
source§impl Client
impl Client
sourcepub fn get_usage(&self) -> GetUsageFluentBuilder
pub fn get_usage(&self) -> GetUsageFluentBuilder
Constructs a fluent builder for the GetUsage
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
usage_plan_id(impl Into<String>)
/set_usage_plan_id(Option<String>)
:
required: trueThe Id of the usage plan associated with the usage data.
key_id(impl Into<String>)
/set_key_id(Option<String>)
:
required: falseThe Id of the API key associated with the resultant usage data.
start_date(impl Into<String>)
/set_start_date(Option<String>)
:
required: trueThe starting date (e.g., 2016-01-01) of the usage data.
end_date(impl Into<String>)
/set_end_date(Option<String>)
:
required: trueThe ending date (e.g., 2016-12-31) of the usage data.
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetUsageOutput
with field(s):usage_plan_id(Option<String>)
:The plan Id associated with this usage data.
start_date(Option<String>)
:The starting date of the usage data.
end_date(Option<String>)
:The ending date of the usage data.
items(Option<HashMap::<String, Vec::<Vec::<i64>>>>)
:The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example,
{…, “values” : { “{api_key}” : [ [0, 100], [10, 90], [100, 10]]}
, where{api_key}
stands for an API key value and the daily log entry is of the format[used quota, remaining quota]
.position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetUsageError>
source§impl Client
impl Client
sourcepub fn get_usage_plan(&self) -> GetUsagePlanFluentBuilder
pub fn get_usage_plan(&self) -> GetUsagePlanFluentBuilder
Constructs a fluent builder for the GetUsagePlan
operation.
- The fluent builder is configurable:
usage_plan_id(impl Into<String>)
/set_usage_plan_id(Option<String>)
:
required: trueThe identifier of the UsagePlan resource to be retrieved.
- On success, responds with
GetUsagePlanOutput
with field(s):id(Option<String>)
:The identifier of a UsagePlan resource.
name(Option<String>)
:The name of a usage plan.
description(Option<String>)
:The description of a usage plan.
api_stages(Option<Vec::<ApiStage>>)
:The associated API stages of a usage plan.
throttle(Option<ThrottleSettings>)
:A map containing method level throttling information for API stage in a usage plan.
quota(Option<QuotaSettings>)
:The target maximum number of permitted requests per a given unit time interval.
product_code(Option<String>)
:The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<GetUsagePlanError>
source§impl Client
impl Client
sourcepub fn get_usage_plan_key(&self) -> GetUsagePlanKeyFluentBuilder
pub fn get_usage_plan_key(&self) -> GetUsagePlanKeyFluentBuilder
Constructs a fluent builder for the GetUsagePlanKey
operation.
- The fluent builder is configurable:
usage_plan_id(impl Into<String>)
/set_usage_plan_id(Option<String>)
:
required: trueThe Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
key_id(impl Into<String>)
/set_key_id(Option<String>)
:
required: trueThe key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.
- On success, responds with
GetUsagePlanKeyOutput
with field(s):id(Option<String>)
:The Id of a usage plan key.
r#type(Option<String>)
:The type of a usage plan key. Currently, the valid key type is
API_KEY
.value(Option<String>)
:The value of a usage plan key.
name(Option<String>)
:The name of a usage plan key.
- On failure, responds with
SdkError<GetUsagePlanKeyError>
source§impl Client
impl Client
sourcepub fn get_usage_plan_keys(&self) -> GetUsagePlanKeysFluentBuilder
pub fn get_usage_plan_keys(&self) -> GetUsagePlanKeysFluentBuilder
Constructs a fluent builder for the GetUsagePlanKeys
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
usage_plan_id(impl Into<String>)
/set_usage_plan_id(Option<String>)
:
required: trueThe Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
name_query(impl Into<String>)
/set_name_query(Option<String>)
:
required: falseA query parameter specifying the name of the to-be-returned usage plan keys.
- On success, responds with
GetUsagePlanKeysOutput
with field(s):items(Option<Vec::<UsagePlanKey>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetUsagePlanKeysError>
source§impl Client
impl Client
sourcepub fn get_usage_plans(&self) -> GetUsagePlansFluentBuilder
pub fn get_usage_plans(&self) -> GetUsagePlansFluentBuilder
Constructs a fluent builder for the GetUsagePlans
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
key_id(impl Into<String>)
/set_key_id(Option<String>)
:
required: falseThe identifier of the API key associated with the usage plans.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetUsagePlansOutput
with field(s):items(Option<Vec::<UsagePlan>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetUsagePlansError>
source§impl Client
impl Client
sourcepub fn get_vpc_link(&self) -> GetVpcLinkFluentBuilder
pub fn get_vpc_link(&self) -> GetVpcLinkFluentBuilder
Constructs a fluent builder for the GetVpcLink
operation.
- The fluent builder is configurable:
vpc_link_id(impl Into<String>)
/set_vpc_link_id(Option<String>)
:
required: trueThe identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
- On success, responds with
GetVpcLinkOutput
with field(s):id(Option<String>)
:The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
name(Option<String>)
:The name used to label and identify the VPC link.
description(Option<String>)
:The description of the VPC link.
target_arns(Option<Vec::<String>>)
:The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.
status(Option<VpcLinkStatus>)
:The status of the VPC link. The valid values are
AVAILABLE
,PENDING
,DELETING
, orFAILED
. Deploying an API will wait if the status isPENDING
and will fail if the status isDELETING
.status_message(Option<String>)
:A description about the VPC link status.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<GetVpcLinkError>
source§impl Client
impl Client
sourcepub fn get_vpc_links(&self) -> GetVpcLinksFluentBuilder
pub fn get_vpc_links(&self) -> GetVpcLinksFluentBuilder
Constructs a fluent builder for the GetVpcLinks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
position(impl Into<String>)
/set_position(Option<String>)
:
required: falseThe current pagination position in the paged result set.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- On success, responds with
GetVpcLinksOutput
with field(s):items(Option<Vec::<VpcLink>>)
:The current page of elements from this collection.
position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<GetVpcLinksError>
source§impl Client
impl Client
sourcepub fn import_api_keys(&self) -> ImportApiKeysFluentBuilder
pub fn import_api_keys(&self) -> ImportApiKeysFluentBuilder
Constructs a fluent builder for the ImportApiKeys
operation.
- The fluent builder is configurable:
body(Blob)
/set_body(Option<Blob>)
:
required: trueThe payload of the POST request to import API keys. For the payload format, see API Key File Format.
format(ApiKeysFormat)
/set_format(Option<ApiKeysFormat>)
:
required: trueA query parameter to specify the input format to imported API keys. Currently, only the
csv
format is supported.fail_on_warnings(bool)
/set_fail_on_warnings(Option<bool>)
:
required: falseA query parameter to indicate whether to rollback ApiKey importation (
true
) or not (false
) when error is encountered.
- On success, responds with
ImportApiKeysOutput
with field(s):ids(Option<Vec::<String>>)
:A list of all the ApiKey identifiers.
warnings(Option<Vec::<String>>)
:A list of warning messages.
- On failure, responds with
SdkError<ImportApiKeysError>
source§impl Client
impl Client
sourcepub fn import_documentation_parts(
&self
) -> ImportDocumentationPartsFluentBuilder
pub fn import_documentation_parts( &self ) -> ImportDocumentationPartsFluentBuilder
Constructs a fluent builder for the ImportDocumentationParts
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
mode(PutMode)
/set_mode(Option<PutMode>)
:
required: falseA query parameter to indicate whether to overwrite (
overwrite
) any existing DocumentationParts definition or to merge (merge
) the new definition into the existing one. The default value ismerge
.fail_on_warnings(bool)
/set_fail_on_warnings(Option<bool>)
:
required: falseA query parameter to specify whether to rollback the documentation importation (
true
) or not (false
) when a warning is encountered. The default value isfalse
.body(Blob)
/set_body(Option<Blob>)
:
required: trueRaw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
- On success, responds with
ImportDocumentationPartsOutput
with field(s):ids(Option<Vec::<String>>)
:A list of the returned documentation part identifiers.
warnings(Option<Vec::<String>>)
:A list of warning messages reported during import of documentation parts.
- On failure, responds with
SdkError<ImportDocumentationPartsError>
source§impl Client
impl Client
sourcepub fn import_rest_api(&self) -> ImportRestApiFluentBuilder
pub fn import_rest_api(&self) -> ImportRestApiFluentBuilder
Constructs a fluent builder for the ImportRestApi
operation.
- The fluent builder is configurable:
fail_on_warnings(bool)
/set_fail_on_warnings(Option<bool>)
:
required: falseA query parameter to indicate whether to rollback the API creation (
true
) or not (false
) when a warning is encountered. The default value isfalse
.parameters(impl Into<String>, impl Into<String>)
/set_parameters(Option<HashMap::<String, String>>)
:
required: falseA key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.
To exclude DocumentationParts from the import, set
parameters
asignore=documentation
.To configure the endpoint type, set
parameters
asendpointConfigurationTypes=EDGE
,endpointConfigurationTypes=REGIONAL
, orendpointConfigurationTypes=PRIVATE
. The default endpoint type isEDGE
.To handle imported
basepath
, setparameters
asbasepath=ignore
,basepath=prepend
orbasepath=split
.body(Blob)
/set_body(Option<Blob>)
:
required: trueThe POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
- On success, responds with
ImportRestApiOutput
with field(s):id(Option<String>)
:The API’s identifier. This identifier is unique across all of your APIs in API Gateway.
name(Option<String>)
:The API’s name.
description(Option<String>)
:The API’s description.
created_date(Option<DateTime>)
:The timestamp when the API was created.
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.binary_media_types(Option<Vec::<String>>)
:The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
minimum_compression_size(Option<i32>)
:A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
api_key_source(Option<ApiKeySourceType>)
:The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.endpoint_configuration(Option<EndpointConfiguration>)
:The endpoint configuration of this RestApi showing the endpoint types of the API.
policy(Option<String>)
:A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
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 defaulthttps://{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.root_resource_id(Option<String>)
:The API’s root resource ID.
- On failure, responds with
SdkError<ImportRestApiError>
source§impl Client
impl Client
sourcepub fn put_gateway_response(&self) -> PutGatewayResponseFluentBuilder
pub fn put_gateway_response(&self) -> PutGatewayResponseFluentBuilder
Constructs a fluent builder for the PutGatewayResponse
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
response_type(GatewayResponseType)
/set_response_type(Option<GatewayResponseType>)
:
required: trueThe response type of the associated GatewayResponse
status_code(impl Into<String>)
/set_status_code(Option<String>)
:
required: falseThe HTTP status code of the GatewayResponse.
response_parameters(impl Into<String>, impl Into<String>)
/set_response_parameters(Option<HashMap::<String, String>>)
:
required: falseResponse parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
response_templates(impl Into<String>, impl Into<String>)
/set_response_templates(Option<HashMap::<String, String>>)
:
required: falseResponse templates of the GatewayResponse as a string-to-string map of key-value pairs.
- On success, responds with
PutGatewayResponseOutput
with field(s):response_type(Option<GatewayResponseType>)
:The response type of the associated GatewayResponse.
status_code(Option<String>)
:The HTTP status code for this GatewayResponse.
response_parameters(Option<HashMap::<String, String>>)
:Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
response_templates(Option<HashMap::<String, String>>)
:Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
default_response(bool)
:A Boolean flag to indicate whether this GatewayResponse is the default gateway response (
true
) or not (false
). A default gateway response is one generated by API Gateway without any customization by an API developer.
- On failure, responds with
SdkError<PutGatewayResponseError>
source§impl Client
impl Client
sourcepub fn put_integration(&self) -> PutIntegrationFluentBuilder
pub fn put_integration(&self) -> PutIntegrationFluentBuilder
Constructs a fluent builder for the PutIntegration
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueSpecifies a put integration request’s resource ID.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueSpecifies the HTTP method for the integration.
r#type(IntegrationType)
/set_type(Option<IntegrationType>)
:
required: trueSpecifies a put integration input’s type.
integration_http_method(impl Into<String>)
/set_integration_http_method(Option<String>)
:
required: falseThe HTTP method for the integration.
uri(impl Into<String>)
/set_uri(Option<String>)
:
required: falseSpecifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or
HTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, whereconnectionType
is notVPC_LINK
, or private integration, whereconnectionType
isVPC_LINK
. For a private HTTP integration, the URI is not used for routing. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api
}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}… query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API ofGetObject
, theuri
can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
.connection_type(ConnectionType)
/set_connection_type(Option<ConnectionType>)
:
required: falseThe type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.connection_id(impl Into<String>)
/set_connection_id(Option<String>)
:
required: falseThe ID of the VpcLink used for the integration. Specify this value only if you specify
VPC_LINK
as the connection type.credentials(impl Into<String>)
/set_credentials(Option<String>)
:
required: falseSpecifies whether credentials are required for a put integration.
request_parameters(impl Into<String>, impl Into<String>)
/set_request_parameters(Option<HashMap::<String, String>>)
:
required: falseA key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of
method.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.request_templates(impl Into<String>, impl Into<String>)
/set_request_templates(Option<HashMap::<String, String>>)
:
required: falseRepresents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
passthrough_behavior(impl Into<String>)
/set_passthrough_behavior(Option<String>)
:
required: falseSpecifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the
requestTemplates
property on the Integration resource. There are three valid values:WHEN_NO_MATCH
,WHEN_NO_TEMPLATES
, andNEVER
.cache_namespace(impl Into<String>)
/set_cache_namespace(Option<String>)
:
required: falseSpecifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources.cache_key_parameters(impl Into<String>)
/set_cache_key_parameters(Option<Vec::<String>>)
:
required: falseA list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
.content_handling(ContentHandlingStrategy)
/set_content_handling(Option<ContentHandlingStrategy>)
:
required: falseSpecifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the
passthroughBehavior
is configured to support payload pass-through.timeout_in_millis(i32)
/set_timeout_in_millis(Option<i32>)
:
required: falseCustom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
tls_config(TlsConfig)
/set_tls_config(Option<TlsConfig>)
:
required: falseSpecifies the TLS configuration for an integration.
- On success, responds with
PutIntegrationOutput
with field(s):r#type(Option<IntegrationType>)
:Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (
http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with aconnectionType
ofVPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.http_method(Option<String>)
:Specifies the integration’s HTTP method type. For the Type property, if you specify
MOCK
, this property is optional. For Lambda integrations, you must set the integration method toPOST
. For all other types, you must specify this property.uri(Option<String>)
:Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For
HTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. IfconnectionType
isVPC_LINK
specify the Network Load Balancer DNS name. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}
. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}… query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
connection_type(Option<ConnectionType>)
:The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.connection_id(Option<String>)
:The ID of the VpcLink used for the integration when
connectionType=VPC_LINK
and undefined, otherwise.credentials(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 Amazon Web Services services, specify null.request_parameters(Option<HashMap::<String, String>>)
:A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of
method.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.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.
passthrough_behavior(Option<String>)
:Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in
requestTemplates
. The valid value is one of the following:WHEN_NO_MATCH
: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.WHEN_NO_TEMPLATES
: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.NEVER
: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.content_handling(Option<ContentHandlingStrategy>)
:Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the
passthroughBehavior
is configured to support payload pass-through.timeout_in_millis(i32)
:Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
cache_namespace(Option<String>)
:Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources.cache_key_parameters(Option<Vec::<String>>)
:A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
.integration_responses(Option<HashMap::<String, IntegrationResponse>>)
:Specifies the integration’s responses.
tls_config(Option<TlsConfig>)
:Specifies the TLS configuration for an integration.
- On failure, responds with
SdkError<PutIntegrationError>
source§impl Client
impl Client
sourcepub fn put_integration_response(&self) -> PutIntegrationResponseFluentBuilder
pub fn put_integration_response(&self) -> PutIntegrationResponseFluentBuilder
Constructs a fluent builder for the PutIntegrationResponse
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueSpecifies a put integration response request’s resource identifier.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueSpecifies a put integration response request’s HTTP method.
status_code(impl Into<String>)
/set_status_code(Option<String>)
:
required: trueSpecifies the status code that is used to map the integration response to an existing MethodResponse.
selection_pattern(impl Into<String>)
/set_selection_pattern(Option<String>)
:
required: falseSpecifies the selection pattern of a put integration response.
response_parameters(impl Into<String>, impl Into<String>)
/set_response_parameters(Option<HashMap::<String, String>>)
:
required: falseA key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of
method.response.header.{name}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
must be a valid and unique response header name andJSON-expression
a valid JSON expression without the$
prefix.response_templates(impl Into<String>, impl Into<String>)
/set_response_templates(Option<HashMap::<String, String>>)
:
required: falseSpecifies a put integration response’s templates.
content_handling(ContentHandlingStrategy)
/set_content_handling(Option<ContentHandlingStrategy>)
:
required: falseSpecifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- On success, responds with
PutIntegrationResponseOutput
with field(s):status_code(Option<String>)
:Specifies the status code that is used to map the integration response to an existing MethodResponse.
selection_pattern(Option<String>)
:Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the
.+
regex to match error response. However, make sure that the error response does not contain any newline (\n
) character in such cases. If the back end is an Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched.response_parameters(Option<HashMap::<String, String>>)
:A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of
method.response.header.{name}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
is a valid and unique response header name andJSON-expression
is a valid JSON expression without the$
prefix.response_templates(Option<HashMap::<String, String>>)
:Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
content_handling(Option<ContentHandlingStrategy>)
:Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- On failure, responds with
SdkError<PutIntegrationResponseError>
source§impl Client
impl Client
sourcepub fn put_method(&self) -> PutMethodFluentBuilder
pub fn put_method(&self) -> PutMethodFluentBuilder
Constructs a fluent builder for the PutMethod
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe Resource identifier for the new Method resource.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueSpecifies the method request’s HTTP method type.
authorization_type(impl Into<String>)
/set_authorization_type(Option<String>)
:
required: trueThe method’s authorization type. Valid values are
NONE
for open access,AWS_IAM
for using AWS IAM permissions,CUSTOM
for using a custom authorizer, orCOGNITO_USER_POOLS
for using a Cognito user pool.authorizer_id(impl Into<String>)
/set_authorizer_id(Option<String>)
:
required: falseSpecifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.
api_key_required(bool)
/set_api_key_required(Option<bool>)
:
required: falseSpecifies whether the method required a valid ApiKey.
operation_name(impl Into<String>)
/set_operation_name(Option<String>)
:
required: falseA human-friendly operation identifier for the method. For example, you can assign the
operationName
ofListPets
for theGET /pets
method in thePetStore
example.request_parameters(impl Into<String>, bool)
/set_request_parameters(Option<HashMap::<String, bool>>)
:
required: falseA key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of
method.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true
) or optional (false
). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.request_models(impl Into<String>, impl Into<String>)
/set_request_models(Option<HashMap::<String, String>>)
:
required: falseSpecifies the Model resources used for the request’s content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
request_validator_id(impl Into<String>)
/set_request_validator_id(Option<String>)
:
required: falseThe identifier of a RequestValidator for validating the method request.
authorization_scopes(impl Into<String>)
/set_authorization_scopes(Option<Vec::<String>>)
:
required: falseA list of authorization scopes configured on the method. The scopes are used with a
COGNITO_USER_POOLS
authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- On success, responds with
PutMethodOutput
with field(s):http_method(Option<String>)
:The method’s HTTP verb.
authorization_type(Option<String>)
:The method’s authorization type. Valid values are
NONE
for open access,AWS_IAM
for using AWS IAM permissions,CUSTOM
for using a custom authorizer, orCOGNITO_USER_POOLS
for using a Cognito user pool.authorizer_id(Option<String>)
:The identifier of an Authorizer to use on this method. The
authorizationType
must beCUSTOM
.api_key_required(Option<bool>)
:A boolean flag specifying whether a valid ApiKey is required to invoke this method.
request_validator_id(Option<String>)
:The identifier of a RequestValidator for request validation.
operation_name(Option<String>)
:A human-friendly operation identifier for the method. For example, you can assign the
operationName
ofListPets
for theGET /pets
method in thePetStore
example.request_parameters(Option<HashMap::<String, bool>>)
:A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of
method.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true
) or optional (false
). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.request_models(Option<HashMap::<String, String>>)
:A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
method_responses(Option<HashMap::<String, MethodResponse>>)
:Gets a method response associated with a given HTTP status code.
method_integration(Option<Integration>)
:Gets the method’s integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
authorization_scopes(Option<Vec::<String>>)
:A list of authorization scopes configured on the method. The scopes are used with a
COGNITO_USER_POOLS
authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- On failure, responds with
SdkError<PutMethodError>
source§impl Client
impl Client
sourcepub fn put_method_response(&self) -> PutMethodResponseFluentBuilder
pub fn put_method_response(&self) -> PutMethodResponseFluentBuilder
Constructs a fluent builder for the PutMethodResponse
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe Resource identifier for the Method resource.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueThe HTTP verb of the Method resource.
status_code(impl Into<String>)
/set_status_code(Option<String>)
:
required: trueThe method response’s status code.
response_parameters(impl Into<String>, bool)
/set_response_parameters(Option<HashMap::<String, bool>>)
:
required: falseA key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of
method.response.header.{name}
, wherename
is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed inintegration.response.header.{name}
, a static value enclosed within a pair of single quotes (e.g.,‘application/json’
), or a JSON expression from the back-end response payload in the form ofintegration.response.body.{JSON-expression}
, whereJSON-expression
is a valid JSON expression without the$
prefix.)response_models(impl Into<String>, impl Into<String>)
/set_response_models(Option<HashMap::<String, String>>)
:
required: falseSpecifies the Model resources used for the response’s content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
- On success, responds with
PutMethodResponseOutput
with field(s):status_code(Option<String>)
:The method response’s status code.
response_parameters(Option<HashMap::<String, bool>>)
:A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern
method.response.header.{name}
, wherename
is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API’s IntegrationResponse. The integration response data that can be mapped include an integration response header expressed inintegration.response.header.{name}
, a static value enclosed within a pair of single quotes (e.g.,‘application/json’
), or a JSON expression from the back-end response payload in the form ofintegration.response.body.{JSON-expression}
, whereJSON-expression
is a valid JSON expression without the$
prefix.)response_models(Option<HashMap::<String, String>>)
:Specifies the Model resources used for the response’s content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
- On failure, responds with
SdkError<PutMethodResponseError>
source§impl Client
impl Client
sourcepub fn put_rest_api(&self) -> PutRestApiFluentBuilder
pub fn put_rest_api(&self) -> PutRestApiFluentBuilder
Constructs a fluent builder for the PutRestApi
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
mode(PutMode)
/set_mode(Option<PutMode>)
:
required: falseThe
mode
query parameter to specify the update mode. Valid values are “merge” and “overwrite”. By default, the update mode is “merge”.fail_on_warnings(bool)
/set_fail_on_warnings(Option<bool>)
:
required: falseA query parameter to indicate whether to rollback the API update (
true
) or not (false
) when a warning is encountered. The default value isfalse
.parameters(impl Into<String>, impl Into<String>)
/set_parameters(Option<HashMap::<String, String>>)
:
required: falseCustom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set
ignore=documentation
as aparameters
value, as in the AWS CLI command ofaws apigateway import-rest-api –parameters ignore=documentation –body ‘file:///path/to/imported-api-body.json’
.body(Blob)
/set_body(Option<Blob>)
:
required: trueThe PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
- On success, responds with
PutRestApiOutput
with field(s):id(Option<String>)
:The API’s identifier. This identifier is unique across all of your APIs in API Gateway.
name(Option<String>)
:The API’s name.
description(Option<String>)
:The API’s description.
created_date(Option<DateTime>)
:The timestamp when the API was created.
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.binary_media_types(Option<Vec::<String>>)
:The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
minimum_compression_size(Option<i32>)
:A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
api_key_source(Option<ApiKeySourceType>)
:The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.endpoint_configuration(Option<EndpointConfiguration>)
:The endpoint configuration of this RestApi showing the endpoint types of the API.
policy(Option<String>)
:A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
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 defaulthttps://{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.root_resource_id(Option<String>)
:The API’s root resource ID.
- On failure, responds with
SdkError<PutRestApiError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of a resource that can be tagged.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueThe key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:
. The tag value can be up to 256 characters.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
Constructs a fluent builder for the TestInvokeAuthorizer
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
authorizer_id(impl Into<String>)
/set_authorizer_id(Option<String>)
:
required: trueSpecifies a test invoke authorizer request’s Authorizer ID.
headers(impl Into<String>, impl Into<String>)
/set_headers(Option<HashMap::<String, String>>)
:
required: falseA key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
multi_value_headers(impl Into<String>, Vec::<String>)
/set_multi_value_headers(Option<HashMap::<String, Vec::<String>>>)
:
required: falseThe headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
path_with_query_string(impl Into<String>)
/set_path_with_query_string(Option<String>)
:
required: falseThe URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
body(impl Into<String>)
/set_body(Option<String>)
:
required: falseThe simulated request body of an incoming invocation request.
stage_variables(impl Into<String>, impl Into<String>)
/set_stage_variables(Option<HashMap::<String, String>>)
:
required: falseA key-value map of stage variables to simulate an invocation on a deployed Stage.
additional_context(impl Into<String>, impl Into<String>)
/set_additional_context(Option<HashMap::<String, String>>)
:
required: falseA key-value map of additional context variables.
- On success, responds with
TestInvokeAuthorizerOutput
with field(s):client_status(i32)
:The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
log(Option<String>)
:The API Gateway execution log for the test authorizer request.
latency(i64)
:The execution latency, in ms, of the test authorizer request.
principal_id(Option<String>)
:The principal identity returned by the Authorizer
policy(Option<String>)
:The JSON policy document returned by the Authorizer
authorization(Option<HashMap::<String, Vec::<String>>>)
:The authorization response.
claims(Option<HashMap::<String, String>>)
:The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
- On failure, responds with
SdkError<TestInvokeAuthorizerError>
source§impl Client
impl Client
sourcepub fn test_invoke_method(&self) -> TestInvokeMethodFluentBuilder
pub fn test_invoke_method(&self) -> TestInvokeMethodFluentBuilder
Constructs a fluent builder for the TestInvokeMethod
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueSpecifies a test invoke method request’s resource ID.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueSpecifies a test invoke method request’s HTTP method.
path_with_query_string(impl Into<String>)
/set_path_with_query_string(Option<String>)
:
required: falseThe URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
body(impl Into<String>)
/set_body(Option<String>)
:
required: falseThe simulated request body of an incoming invocation request.
headers(impl Into<String>, impl Into<String>)
/set_headers(Option<HashMap::<String, String>>)
:
required: falseA key-value map of headers to simulate an incoming invocation request.
multi_value_headers(impl Into<String>, Vec::<String>)
/set_multi_value_headers(Option<HashMap::<String, Vec::<String>>>)
:
required: falseThe headers as a map from string to list of values to simulate an incoming invocation request.
client_certificate_id(impl Into<String>)
/set_client_certificate_id(Option<String>)
:
required: falseA ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
stage_variables(impl Into<String>, impl Into<String>)
/set_stage_variables(Option<HashMap::<String, String>>)
:
required: falseA key-value map of stage variables to simulate an invocation on a deployed Stage.
- On success, responds with
TestInvokeMethodOutput
with field(s):status(i32)
:The HTTP status code.
body(Option<String>)
:The body of the HTTP response.
headers(Option<HashMap::<String, String>>)
:The headers of the HTTP response.
multi_value_headers(Option<HashMap::<String, Vec::<String>>>)
:The headers of the HTTP response as a map from string to list of values.
log(Option<String>)
:The API Gateway execution log for the test invoke request.
latency(i64)
:The execution latency, in ms, of the test invoke request.
- On failure, responds with
SdkError<TestInvokeMethodError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of a resource that can be tagged.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe Tag keys to delete.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_account(&self) -> UpdateAccountFluentBuilder
pub fn update_account(&self) -> UpdateAccountFluentBuilder
Constructs a fluent builder for the UpdateAccount
operation.
- The fluent builder is configurable:
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateAccountOutput
with field(s):cloudwatch_role_arn(Option<String>)
:The ARN of an Amazon CloudWatch role for the current Account.
throttle_settings(Option<ThrottleSettings>)
:Specifies the API request limits configured for the current Account.
features(Option<Vec::<String>>)
:A list of features supported for the account. When usage plans are enabled, the features list will include an entry of
“UsagePlans”
.api_key_version(Option<String>)
:The version of the API keys used for the account.
- On failure, responds with
SdkError<UpdateAccountError>
source§impl Client
impl Client
sourcepub fn update_api_key(&self) -> UpdateApiKeyFluentBuilder
pub fn update_api_key(&self) -> UpdateApiKeyFluentBuilder
Constructs a fluent builder for the UpdateApiKey
operation.
- The fluent builder is configurable:
api_key(impl Into<String>)
/set_api_key(Option<String>)
:
required: trueThe identifier of the ApiKey resource to be updated.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateApiKeyOutput
with field(s):id(Option<String>)
:The identifier of the API Key.
value(Option<String>)
:The value of the API Key.
name(Option<String>)
:The name of the API Key.
customer_id(Option<String>)
:An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
description(Option<String>)
:The description of the API Key.
enabled(bool)
:Specifies whether the API Key can be used by callers.
created_date(Option<DateTime>)
:The timestamp when the API Key was created.
last_updated_date(Option<DateTime>)
:The timestamp when the API Key was last updated.
stage_keys(Option<Vec::<String>>)
:A list of Stage resources that are associated with the ApiKey resource.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<UpdateApiKeyError>
source§impl Client
impl Client
Constructs a fluent builder for the UpdateAuthorizer
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
authorizer_id(impl Into<String>)
/set_authorizer_id(Option<String>)
:
required: trueThe identifier of the Authorizer resource.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateAuthorizerOutput
with field(s):id(Option<String>)
:The identifier for the authorizer resource.
name(Option<String>)
:The name of the authorizer.
r#type(Option<AuthorizerType>)
:The authorizer type. Valid values are
TOKEN
for a Lambda function using a single authorization token submitted in a custom header,REQUEST
for a Lambda function using incoming request parameters, andCOGNITO_USER_POOLS
for using an Amazon Cognito user pool.provider_arns(Option<Vec::<String>>)
:A list of the Amazon Cognito user pool ARNs for the
COGNITO_USER_POOLS
authorizer. Each element is of this format:arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}
. For aTOKEN
orREQUEST
authorizer, this is not defined.auth_type(Option<String>)
:Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
authorizer_uri(Option<String>)
:Specifies the authorizer’s Uniform Resource Identifier (URI). For
TOKEN
orREQUEST
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 formarn: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
.authorizer_credentials(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, specify null.
identity_source(Option<String>)
:The identity source for which authorization is requested. For a
TOKEN
orCOGNITO_USER_POOLS
authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name isAuth
, the header mapping expression ismethod.request.header.Auth
. For theREQUEST
authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if anAuth
header, aName
query string parameter are defined as identity sources, this value ismethod.request.header.Auth
,method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.identity_validation_expression(Option<String>)
:A validation expression for the incoming identity token. For
TOKEN
authorizers, this value is a regular expression. ForCOGNITO_USER_POOLS
authorizers, API Gateway will match theaud
field of the incoming token from the client against the specified regular expression. It will invoke the authorizer’s Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to theREQUEST
authorizer.authorizer_result_ttl_in_seconds(Option<i32>)
:The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- On failure, responds with
SdkError<UpdateAuthorizerError>
source§impl Client
impl Client
sourcepub fn update_base_path_mapping(&self) -> UpdateBasePathMappingFluentBuilder
pub fn update_base_path_mapping(&self) -> UpdateBasePathMappingFluentBuilder
Constructs a fluent builder for the UpdateBasePathMapping
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe domain name of the BasePathMapping resource to change.
base_path(impl Into<String>)
/set_base_path(Option<String>)
:
required: trueThe base path of the BasePathMapping resource to change.
To specify an empty base path, set this parameter to
‘(none)’
.patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateBasePathMappingOutput
with field(s):base_path(Option<String>)
:The base path name that callers of the API must provide as part of the URL after the domain name.
rest_api_id(Option<String>)
:The string identifier of the associated RestApi.
stage(Option<String>)
:The name of the associated stage.
- On failure, responds with
SdkError<UpdateBasePathMappingError>
source§impl Client
impl Client
sourcepub fn update_client_certificate(&self) -> UpdateClientCertificateFluentBuilder
pub fn update_client_certificate(&self) -> UpdateClientCertificateFluentBuilder
Constructs a fluent builder for the UpdateClientCertificate
operation.
- The fluent builder is configurable:
client_certificate_id(impl Into<String>)
/set_client_certificate_id(Option<String>)
:
required: trueThe identifier of the ClientCertificate resource to be updated.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateClientCertificateOutput
with field(s):client_certificate_id(Option<String>)
:The identifier of the client certificate.
description(Option<String>)
:The description of the client certificate.
pem_encoded_certificate(Option<String>)
:The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
created_date(Option<DateTime>)
:The timestamp when the client certificate was created.
expiration_date(Option<DateTime>)
:The timestamp when the client certificate will expire.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<UpdateClientCertificateError>
source§impl Client
impl Client
sourcepub fn update_deployment(&self) -> UpdateDeploymentFluentBuilder
pub fn update_deployment(&self) -> UpdateDeploymentFluentBuilder
Constructs a fluent builder for the UpdateDeployment
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe replacement identifier for the Deployment resource to change information about.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateDeploymentOutput
with field(s):id(Option<String>)
:The identifier for the deployment resource.
description(Option<String>)
:The description for the deployment resource.
created_date(Option<DateTime>)
:The date and time that the deployment resource was created.
api_summary(Option<HashMap::<String, HashMap::<String, MethodSnapshot>>>)
:A summary of the RestApi at the date and time that the deployment resource was created.
- On failure, responds with
SdkError<UpdateDeploymentError>
source§impl Client
impl Client
sourcepub fn update_documentation_part(&self) -> UpdateDocumentationPartFluentBuilder
pub fn update_documentation_part(&self) -> UpdateDocumentationPartFluentBuilder
Constructs a fluent builder for the UpdateDocumentationPart
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
documentation_part_id(impl Into<String>)
/set_documentation_part_id(Option<String>)
:
required: trueThe identifier of the to-be-updated documentation part.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateDocumentationPartOutput
with field(s):id(Option<String>)
:The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart
is created.location(Option<DocumentationPartLocation>)
:The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
properties(Option<String>)
:A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g.,
“{ "description": "The API does …" }”
. Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension ofx-amazon-apigateway-documentation
.
- On failure, responds with
SdkError<UpdateDocumentationPartError>
source§impl Client
impl Client
sourcepub fn update_documentation_version(
&self
) -> UpdateDocumentationVersionFluentBuilder
pub fn update_documentation_version( &self ) -> UpdateDocumentationVersionFluentBuilder
Constructs a fluent builder for the UpdateDocumentationVersion
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
documentation_version(impl Into<String>)
/set_documentation_version(Option<String>)
:
required: trueThe version identifier of the to-be-updated documentation version.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateDocumentationVersionOutput
with field(s):version(Option<String>)
:The version identifier of the API documentation snapshot.
created_date(Option<DateTime>)
:The date when the API documentation snapshot is created.
description(Option<String>)
:The description of the API documentation snapshot.
- On failure, responds with
SdkError<UpdateDocumentationVersionError>
source§impl Client
impl Client
sourcepub fn update_domain_name(&self) -> UpdateDomainNameFluentBuilder
pub fn update_domain_name(&self) -> UpdateDomainNameFluentBuilder
Constructs a fluent builder for the UpdateDomainName
operation.
- The fluent builder is configurable:
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:
required: trueThe name of the DomainName resource to be changed.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateDomainNameOutput
with field(s):domain_name(Option<String>)
:The custom domain name as an API host name, for example,
my-api.example.com
.certificate_name(Option<String>)
:The name of the certificate that will be used by edge-optimized endpoint for this domain name.
certificate_arn(Option<String>)
:The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.
certificate_upload_date(Option<DateTime>)
:The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
regional_domain_name(Option<String>)
:The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
regional_hosted_zone_id(Option<String>)
:The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
regional_certificate_name(Option<String>)
:The name of the certificate that will be used for validating the regional domain name.
regional_certificate_arn(Option<String>)
:The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
distribution_domain_name(Option<String>)
:The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
distribution_hosted_zone_id(Option<String>)
:The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.endpoint_configuration(Option<EndpointConfiguration>)
:The endpoint configuration of this DomainName showing the endpoint types of the domain name.
domain_name_status(Option<DomainNameStatus>)
:The status of the DomainName migration. The valid values are
AVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, the domain can be updated.domain_name_status_message(Option<String>)
:An optional text message containing detailed information about status of the DomainName migration.
security_policy(Option<SecurityPolicy>)
:The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
.tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
mutual_tls_authentication(Option<MutualTlsAuthentication>)
:The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
ownership_verification_certificate_arn(Option<String>)
:The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
- On failure, responds with
SdkError<UpdateDomainNameError>
source§impl Client
impl Client
sourcepub fn update_gateway_response(&self) -> UpdateGatewayResponseFluentBuilder
pub fn update_gateway_response(&self) -> UpdateGatewayResponseFluentBuilder
Constructs a fluent builder for the UpdateGatewayResponse
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
response_type(GatewayResponseType)
/set_response_type(Option<GatewayResponseType>)
:
required: trueThe response type of the associated GatewayResponse.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateGatewayResponseOutput
with field(s):response_type(Option<GatewayResponseType>)
:The response type of the associated GatewayResponse.
status_code(Option<String>)
:The HTTP status code for this GatewayResponse.
response_parameters(Option<HashMap::<String, String>>)
:Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
response_templates(Option<HashMap::<String, String>>)
:Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
default_response(bool)
:A Boolean flag to indicate whether this GatewayResponse is the default gateway response (
true
) or not (false
). A default gateway response is one generated by API Gateway without any customization by an API developer.
- On failure, responds with
SdkError<UpdateGatewayResponseError>
source§impl Client
impl Client
sourcepub fn update_integration(&self) -> UpdateIntegrationFluentBuilder
pub fn update_integration(&self) -> UpdateIntegrationFluentBuilder
Constructs a fluent builder for the UpdateIntegration
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueRepresents an update integration request’s resource identifier.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueRepresents an update integration request’s HTTP method.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateIntegrationOutput
with field(s):r#type(Option<IntegrationType>)
:Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (
http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with aconnectionType
ofVPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.http_method(Option<String>)
:Specifies the integration’s HTTP method type. For the Type property, if you specify
MOCK
, this property is optional. For Lambda integrations, you must set the integration method toPOST
. For all other types, you must specify this property.uri(Option<String>)
:Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For
HTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. IfconnectionType
isVPC_LINK
specify the Network Load Balancer DNS name. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}
. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}… query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
connection_type(Option<ConnectionType>)
:The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.connection_id(Option<String>)
:The ID of the VpcLink used for the integration when
connectionType=VPC_LINK
and undefined, otherwise.credentials(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 Amazon Web Services services, specify null.request_parameters(Option<HashMap::<String, String>>)
:A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of
method.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.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.
passthrough_behavior(Option<String>)
:Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in
requestTemplates
. The valid value is one of the following:WHEN_NO_MATCH
: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.WHEN_NO_TEMPLATES
: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.NEVER
: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.content_handling(Option<ContentHandlingStrategy>)
:Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the
passthroughBehavior
is configured to support payload pass-through.timeout_in_millis(i32)
:Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
cache_namespace(Option<String>)
:Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources.cache_key_parameters(Option<Vec::<String>>)
:A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
.integration_responses(Option<HashMap::<String, IntegrationResponse>>)
:Specifies the integration’s responses.
tls_config(Option<TlsConfig>)
:Specifies the TLS configuration for an integration.
- On failure, responds with
SdkError<UpdateIntegrationError>
source§impl Client
impl Client
sourcepub fn update_integration_response(
&self
) -> UpdateIntegrationResponseFluentBuilder
pub fn update_integration_response( &self ) -> UpdateIntegrationResponseFluentBuilder
Constructs a fluent builder for the UpdateIntegrationResponse
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueSpecifies an update integration response request’s resource identifier.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueSpecifies an update integration response request’s HTTP method.
status_code(impl Into<String>)
/set_status_code(Option<String>)
:
required: trueSpecifies an update integration response request’s status code.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateIntegrationResponseOutput
with field(s):status_code(Option<String>)
:Specifies the status code that is used to map the integration response to an existing MethodResponse.
selection_pattern(Option<String>)
:Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the
.+
regex to match error response. However, make sure that the error response does not contain any newline (\n
) character in such cases. If the back end is an Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched.response_parameters(Option<HashMap::<String, String>>)
:A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of
method.response.header.{name}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
is a valid and unique response header name andJSON-expression
is a valid JSON expression without the$
prefix.response_templates(Option<HashMap::<String, String>>)
:Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
content_handling(Option<ContentHandlingStrategy>)
:Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- On failure, responds with
SdkError<UpdateIntegrationResponseError>
source§impl Client
impl Client
sourcepub fn update_method(&self) -> UpdateMethodFluentBuilder
pub fn update_method(&self) -> UpdateMethodFluentBuilder
Constructs a fluent builder for the UpdateMethod
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe Resource identifier for the Method resource.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueThe HTTP verb of the Method resource.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateMethodOutput
with field(s):http_method(Option<String>)
:The method’s HTTP verb.
authorization_type(Option<String>)
:The method’s authorization type. Valid values are
NONE
for open access,AWS_IAM
for using AWS IAM permissions,CUSTOM
for using a custom authorizer, orCOGNITO_USER_POOLS
for using a Cognito user pool.authorizer_id(Option<String>)
:The identifier of an Authorizer to use on this method. The
authorizationType
must beCUSTOM
.api_key_required(Option<bool>)
:A boolean flag specifying whether a valid ApiKey is required to invoke this method.
request_validator_id(Option<String>)
:The identifier of a RequestValidator for request validation.
operation_name(Option<String>)
:A human-friendly operation identifier for the method. For example, you can assign the
operationName
ofListPets
for theGET /pets
method in thePetStore
example.request_parameters(Option<HashMap::<String, bool>>)
:A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of
method.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true
) or optional (false
). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.request_models(Option<HashMap::<String, String>>)
:A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
method_responses(Option<HashMap::<String, MethodResponse>>)
:Gets a method response associated with a given HTTP status code.
method_integration(Option<Integration>)
:Gets the method’s integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
authorization_scopes(Option<Vec::<String>>)
:A list of authorization scopes configured on the method. The scopes are used with a
COGNITO_USER_POOLS
authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- On failure, responds with
SdkError<UpdateMethodError>
source§impl Client
impl Client
sourcepub fn update_method_response(&self) -> UpdateMethodResponseFluentBuilder
pub fn update_method_response(&self) -> UpdateMethodResponseFluentBuilder
Constructs a fluent builder for the UpdateMethodResponse
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe Resource identifier for the MethodResponse resource.
http_method(impl Into<String>)
/set_http_method(Option<String>)
:
required: trueThe HTTP verb of the Method resource.
status_code(impl Into<String>)
/set_status_code(Option<String>)
:
required: trueThe status code for the MethodResponse resource.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateMethodResponseOutput
with field(s):status_code(Option<String>)
:The method response’s status code.
response_parameters(Option<HashMap::<String, bool>>)
:A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern
method.response.header.{name}
, wherename
is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API’s IntegrationResponse. The integration response data that can be mapped include an integration response header expressed inintegration.response.header.{name}
, a static value enclosed within a pair of single quotes (e.g.,‘application/json’
), or a JSON expression from the back-end response payload in the form ofintegration.response.body.{JSON-expression}
, whereJSON-expression
is a valid JSON expression without the$
prefix.)response_models(Option<HashMap::<String, String>>)
:Specifies the Model resources used for the response’s content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
- On failure, responds with
SdkError<UpdateMethodResponseError>
source§impl Client
impl Client
sourcepub fn update_model(&self) -> UpdateModelFluentBuilder
pub fn update_model(&self) -> UpdateModelFluentBuilder
Constructs a fluent builder for the UpdateModel
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
model_name(impl Into<String>)
/set_model_name(Option<String>)
:
required: trueThe name of the model to update.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateModelOutput
with field(s):id(Option<String>)
:The identifier for the model resource.
name(Option<String>)
:The name of the model. Must be an alphanumeric string.
description(Option<String>)
:The description of the model.
schema(Option<String>)
:The schema for the model. For
application/json
models, this should be JSON schema draft 4 model. Do not include “*/” characters in the description of any properties because such “*/” characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API’s SDK generated by API Gateway to fail.content_type(Option<String>)
:The content-type for the model.
- On failure, responds with
SdkError<UpdateModelError>
source§impl Client
impl Client
sourcepub fn update_request_validator(&self) -> UpdateRequestValidatorFluentBuilder
pub fn update_request_validator(&self) -> UpdateRequestValidatorFluentBuilder
Constructs a fluent builder for the UpdateRequestValidator
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
request_validator_id(impl Into<String>)
/set_request_validator_id(Option<String>)
:
required: trueThe identifier of RequestValidator to be updated.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateRequestValidatorOutput
with field(s):id(Option<String>)
:The identifier of this RequestValidator.
name(Option<String>)
:The name of this RequestValidator
validate_request_body(bool)
:A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
validate_request_parameters(bool)
:A Boolean flag to indicate whether to validate request parameters (
true
) or not (false
).
- On failure, responds with
SdkError<UpdateRequestValidatorError>
source§impl Client
impl Client
sourcepub fn update_resource(&self) -> UpdateResourceFluentBuilder
pub fn update_resource(&self) -> UpdateResourceFluentBuilder
Constructs a fluent builder for the UpdateResource
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe identifier of the Resource resource.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateResourceOutput
with field(s):id(Option<String>)
:The resource’s identifier.
parent_id(Option<String>)
:The parent resource’s identifier.
path_part(Option<String>)
:The last path segment for this resource.
path(Option<String>)
:The full path for this resource.
resource_methods(Option<HashMap::<String, Method>>)
:Gets an API resource’s method of a given HTTP verb.
- On failure, responds with
SdkError<UpdateResourceError>
source§impl Client
impl Client
sourcepub fn update_rest_api(&self) -> UpdateRestApiFluentBuilder
pub fn update_rest_api(&self) -> UpdateRestApiFluentBuilder
Constructs a fluent builder for the UpdateRestApi
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateRestApiOutput
with field(s):id(Option<String>)
:The API’s identifier. This identifier is unique across all of your APIs in API Gateway.
name(Option<String>)
:The API’s name.
description(Option<String>)
:The API’s description.
created_date(Option<DateTime>)
:The timestamp when the API was created.
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.binary_media_types(Option<Vec::<String>>)
:The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
minimum_compression_size(Option<i32>)
:A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
api_key_source(Option<ApiKeySourceType>)
:The source of the API key for metering requests according to a usage plan. Valid values are: >
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.endpoint_configuration(Option<EndpointConfiguration>)
:The endpoint configuration of this RestApi showing the endpoint types of the API.
policy(Option<String>)
:A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
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 defaulthttps://{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.root_resource_id(Option<String>)
:The API’s root resource ID.
- On failure, responds with
SdkError<UpdateRestApiError>
source§impl Client
impl Client
sourcepub fn update_stage(&self) -> UpdateStageFluentBuilder
pub fn update_stage(&self) -> UpdateStageFluentBuilder
Constructs a fluent builder for the UpdateStage
operation.
- The fluent builder is configurable:
rest_api_id(impl Into<String>)
/set_rest_api_id(Option<String>)
:
required: trueThe string identifier of the associated RestApi.
stage_name(impl Into<String>)
/set_stage_name(Option<String>)
:
required: trueThe name of the Stage resource to change information about.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateStageOutput
with field(s):deployment_id(Option<String>)
:The identifier of the Deployment that the stage points to.
client_certificate_id(Option<String>)
:The identifier of a client certificate for an API stage.
stage_name(Option<String>)
:The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
description(Option<String>)
:The stage’s description.
cache_cluster_enabled(bool)
:Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
totrue
for a method.cache_cluster_size(Option<CacheClusterSize>)
:The stage’s cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
cache_cluster_status(Option<CacheClusterStatus>)
:The status of the cache cluster for the stage, if enabled.
method_settings(Option<HashMap::<String, MethodSetting>>)
:A map that defines the method settings for a Stage resource. Keys (designated as
/{method_setting_key
below) are method paths defined as{resource_path}/{http_method}
for an individual method override, or/*/*
for overriding all methods in the stage.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-._~:/?#&=,]+
.documentation_version(Option<String>)
:The version of the associated API documentation.
access_log_settings(Option<AccessLogSettings>)
:Settings for logging access in this stage.
canary_settings(Option<CanarySettings>)
:Settings for the canary deployment in this stage.
tracing_enabled(bool)
:Specifies whether active tracing with X-ray is enabled for the Stage.
web_acl_arn(Option<String>)
:The ARN of the WebAcl associated with the Stage.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
created_date(Option<DateTime>)
:The timestamp when the stage was created.
last_updated_date(Option<DateTime>)
:The timestamp when the stage last updated.
- On failure, responds with
SdkError<UpdateStageError>
source§impl Client
impl Client
sourcepub fn update_usage(&self) -> UpdateUsageFluentBuilder
pub fn update_usage(&self) -> UpdateUsageFluentBuilder
Constructs a fluent builder for the UpdateUsage
operation.
- The fluent builder is configurable:
usage_plan_id(impl Into<String>)
/set_usage_plan_id(Option<String>)
:
required: trueThe Id of the usage plan associated with the usage data.
key_id(impl Into<String>)
/set_key_id(Option<String>)
:
required: trueThe identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateUsageOutput
with field(s):usage_plan_id(Option<String>)
:The plan Id associated with this usage data.
start_date(Option<String>)
:The starting date of the usage data.
end_date(Option<String>)
:The ending date of the usage data.
items(Option<HashMap::<String, Vec::<Vec::<i64>>>>)
:The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example,
{…, “values” : { “{api_key}” : [ [0, 100], [10, 90], [100, 10]]}
, where{api_key}
stands for an API key value and the daily log entry is of the format[used quota, remaining quota]
.position(Option<String>)
:The current pagination position in the paged result set.
- On failure, responds with
SdkError<UpdateUsageError>
source§impl Client
impl Client
sourcepub fn update_usage_plan(&self) -> UpdateUsagePlanFluentBuilder
pub fn update_usage_plan(&self) -> UpdateUsagePlanFluentBuilder
Constructs a fluent builder for the UpdateUsagePlan
operation.
- The fluent builder is configurable:
usage_plan_id(impl Into<String>)
/set_usage_plan_id(Option<String>)
:
required: trueThe Id of the to-be-updated usage plan.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateUsagePlanOutput
with field(s):id(Option<String>)
:The identifier of a UsagePlan resource.
name(Option<String>)
:The name of a usage plan.
description(Option<String>)
:The description of a usage plan.
api_stages(Option<Vec::<ApiStage>>)
:The associated API stages of a usage plan.
throttle(Option<ThrottleSettings>)
:A map containing method level throttling information for API stage in a usage plan.
quota(Option<QuotaSettings>)
:The target maximum number of permitted requests per a given unit time interval.
product_code(Option<String>)
:The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<UpdateUsagePlanError>
source§impl Client
impl Client
sourcepub fn update_vpc_link(&self) -> UpdateVpcLinkFluentBuilder
pub fn update_vpc_link(&self) -> UpdateVpcLinkFluentBuilder
Constructs a fluent builder for the UpdateVpcLink
operation.
- The fluent builder is configurable:
vpc_link_id(impl Into<String>)
/set_vpc_link_id(Option<String>)
:
required: trueThe identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
patch_operations(PatchOperation)
/set_patch_operations(Option<Vec::<PatchOperation>>)
:
required: falseFor more information about supported patch operations, see Patch Operations.
- On success, responds with
UpdateVpcLinkOutput
with field(s):id(Option<String>)
:The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
name(Option<String>)
:The name used to label and identify the VPC link.
description(Option<String>)
:The description of the VPC link.
target_arns(Option<Vec::<String>>)
:The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.
status(Option<VpcLinkStatus>)
:The status of the VPC link. The valid values are
AVAILABLE
,PENDING
,DELETING
, orFAILED
. Deploying an API will wait if the status isPENDING
and will fail if the status isDELETING
.status_message(Option<String>)
:A description about the VPC link status.
tags(Option<HashMap::<String, String>>)
:The collection of tags. Each tag element is associated with a given resource.
- On failure, responds with
SdkError<UpdateVpcLinkError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more