Struct Client 

pub struct Client { /* private fields */ }

Client for AWS Certificate Manager

Client for invoking operations on AWS Certificate Manager. Each operation on AWS Certificate Manager 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_acm::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 Builder 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_acm::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 AddTagsToCertificate operation has a Client::add_tags_to_certificate, 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.add_tags_to_certificate()
    .certificate_arn("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.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn add_tags_to_certificate(&self) -> AddTagsToCertificateFluentBuilder

Constructs a fluent builder for the AddTagsToCertificate operation.

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: true
    

    String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The key-value pair that defines the tag. The tag value is optional.

    
    
• On success, responds with AddTagsToCertificateOutput
• On failure, responds with SdkError<AddTagsToCertificateError>

impl Client

pub fn create_acme_domain_validation( &self, ) -> CreateAcmeDomainValidationFluentBuilder

Constructs a fluent builder for the CreateAcmeDomainValidation operation.

• The fluent builder is configurable:
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
  • acme_endpoint_arn(impl Into<String>) / set_acme_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME endpoint.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The domain name to validate.

    
    
  • prevalidation_options(PrevalidationOptions) / set_prevalidation_options(Option<PrevalidationOptions>):
    required: true
    

    The prevalidation options for the domain.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    One or more tags to associate with the domain validation.

    
    
• On success, responds with CreateAcmeDomainValidationOutput with field(s):
  • acme_domain_validation_arn(String):

    The Amazon Resource Name (ARN) of the created domain validation.

• On failure, responds with SdkError<CreateAcmeDomainValidationError>

impl Client

pub fn create_acme_endpoint(&self) -> CreateAcmeEndpointFluentBuilder

Constructs a fluent builder for the CreateAcmeEndpoint operation.

• The fluent builder is configurable:
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
  • authorization_behavior(AcmeAuthorizationBehavior) / set_authorization_behavior(Option<AcmeAuthorizationBehavior>):
    required: true
    

    The authorization behavior for the ACME endpoint.

    
    
  • contact(AcmeContact) / set_contact(Option<AcmeContact>):
    required: false
    

    Specifies whether ACME clients must provide contact information during account registration.

    
    
  • certificate_authority(CertificateAuthority) / set_certificate_authority(Option<CertificateAuthority>):
    required: true
    

    The type of certificate authority to use for issuing certificates through this ACME endpoint.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    One or more tags to associate with the ACME endpoint.

    
    
  • certificate_tags(Tag) / set_certificate_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to apply to certificates issued through this ACME endpoint.

    
    
• On success, responds with CreateAcmeEndpointOutput with field(s):
  • acme_endpoint_arn(Option<String>):

    The Amazon Resource Name (ARN) of the created ACME endpoint.

• On failure, responds with SdkError<CreateAcmeEndpointError>

impl Client

pub fn create_acme_external_account_binding( &self, ) -> CreateAcmeExternalAccountBindingFluentBuilder

Constructs a fluent builder for the CreateAcmeExternalAccountBinding operation.

• The fluent builder is configurable:
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
  • acme_endpoint_arn(impl Into<String>) / set_acme_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME endpoint.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role to associate with the external account binding.

    
    
  • expiration(Expiration) / set_expiration(Option<Expiration>):
    required: false
    

    The expiration configuration for the external account binding.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    One or more tags to associate with the external account binding.

    
    
• On success, responds with CreateAcmeExternalAccountBindingOutput with field(s):
  • external_account_binding(Option<AcmeExternalAccountBinding>):

    The created external account binding.

• On failure, responds with SdkError<CreateAcmeExternalAccountBindingError>

impl Client

pub fn delete_acme_domain_validation( &self, ) -> DeleteAcmeDomainValidationFluentBuilder

Constructs a fluent builder for the DeleteAcmeDomainValidation operation.

• The fluent builder is configurable:
  • acme_domain_validation_arn(impl Into<String>) / set_acme_domain_validation_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME domain validation to delete.

    
    
• On success, responds with DeleteAcmeDomainValidationOutput
• On failure, responds with SdkError<DeleteAcmeDomainValidationError>

impl Client

pub fn delete_acme_endpoint(&self) -> DeleteAcmeEndpointFluentBuilder

Constructs a fluent builder for the DeleteAcmeEndpoint operation.

• The fluent builder is configurable:
  • acme_endpoint_arn(impl Into<String>) / set_acme_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME endpoint to delete.

    
    
• On success, responds with DeleteAcmeEndpointOutput
• On failure, responds with SdkError<DeleteAcmeEndpointError>

impl Client

pub fn delete_acme_external_account_binding( &self, ) -> DeleteAcmeExternalAccountBindingFluentBuilder

Constructs a fluent builder for the DeleteAcmeExternalAccountBinding operation.

• The fluent builder is configurable:
  • acme_external_account_binding_arn(impl Into<String>) / set_acme_external_account_binding_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME external account binding to delete.

    
    
• On success, responds with DeleteAcmeExternalAccountBindingOutput
• On failure, responds with SdkError<DeleteAcmeExternalAccountBindingError>

impl Client

pub fn delete_certificate(&self) -> DeleteCertificateFluentBuilder

Constructs a fluent builder for the DeleteCertificate operation.

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: true
    

    String that contains the ARN of the ACM certificate to be deleted. This must be of the form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    
    
• On success, responds with DeleteCertificateOutput
• On failure, responds with SdkError<DeleteCertificateError>

impl Client

pub fn describe_acme_account(&self) -> DescribeAcmeAccountFluentBuilder

Constructs a fluent builder for the DescribeAcmeAccount operation.

• The fluent builder is configurable:
  • acme_endpoint_arn(impl Into<String>) / set_acme_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME endpoint.

    
    
  • account_url(impl Into<String>) / set_account_url(Option<String>):
    required: true
    

    The URL of the ACME account.

    
    
• On success, responds with DescribeAcmeAccountOutput with field(s):
  • acme_account(Option<AcmeAccount>):

    The ACME account details.

• On failure, responds with SdkError<DescribeAcmeAccountError>

impl Client

pub fn describe_acme_domain_validation( &self, ) -> DescribeAcmeDomainValidationFluentBuilder

Constructs a fluent builder for the DescribeAcmeDomainValidation operation.

• The fluent builder is configurable:
  • acme_domain_validation_arn(impl Into<String>) / set_acme_domain_validation_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME domain validation.

    
    
• On success, responds with DescribeAcmeDomainValidationOutput with field(s):
  • acme_domain_validation(Option<AcmeDomainValidation>):

    The ACME domain validation details.

• On failure, responds with SdkError<DescribeAcmeDomainValidationError>

impl Client

pub fn describe_acme_endpoint(&self) -> DescribeAcmeEndpointFluentBuilder

Constructs a fluent builder for the DescribeAcmeEndpoint operation.

• The fluent builder is configurable:
  • acme_endpoint_arn(impl Into<String>) / set_acme_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME endpoint.

    
    
• On success, responds with DescribeAcmeEndpointOutput with field(s):
  • acme_endpoint(Option<AcmeEndpoint>):

    The ACME endpoint details.

• On failure, responds with SdkError<DescribeAcmeEndpointError>

impl Client

pub fn describe_acme_external_account_binding( &self, ) -> DescribeAcmeExternalAccountBindingFluentBuilder

Constructs a fluent builder for the DescribeAcmeExternalAccountBinding operation.

• The fluent builder is configurable:
  • acme_external_account_binding_arn(impl Into<String>) / set_acme_external_account_binding_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME external account binding.

    
    
• On success, responds with DescribeAcmeExternalAccountBindingOutput with field(s):
  • external_account_binding(Option<AcmeExternalAccountBinding>):

    The external account binding details.

• On failure, responds with SdkError<DescribeAcmeExternalAccountBindingError>

impl Client

pub fn describe_certificate(&self) -> DescribeCertificateFluentBuilder

Constructs a fluent builder for the DescribeCertificate operation.

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    
    
• On success, responds with DescribeCertificateOutput with field(s):
  • certificate(Option<CertificateDetail>):

    Metadata about an ACM certificate.

• On failure, responds with SdkError<DescribeCertificateError>

impl Client

pub fn export_certificate(&self) -> ExportCertificateFluentBuilder

Constructs a fluent builder for the ExportCertificate operation.

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: true
    

    An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:

    arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012

    
    
  • passphrase(Blob) / set_passphrase(Option<Blob>):
    required: true
    

    Passphrase to associate with the encrypted exported private key.

    When creating your passphrase, you can use any ASCII character except #, $, or %.

    If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key. After entering the command, you are prompted for the passphrase.

    openssl rsa -in encrypted_key.pem -out decrypted_key.pem

    
    
• On success, responds with ExportCertificateOutput with field(s):
  • certificate(Option<String>):

    The base64 PEM-encoded certificate.

  • certificate_chain(Option<String>):

    The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting.

  • private_key(Option<String>):

    The encrypted private key associated with the public key in the certificate. The key is output in PKCS #8 format and is base64 PEM-encoded.

• On failure, responds with SdkError<ExportCertificateError>

impl Client

pub fn get_account_configuration(&self) -> GetAccountConfigurationFluentBuilder

Constructs a fluent builder for the GetAccountConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetAccountConfigurationOutput with field(s):
  • expiry_events(Option<ExpiryEventsConfiguration>):

    Expiration events configuration options associated with the Amazon Web Services account.

• On failure, responds with SdkError<GetAccountConfigurationError>

impl Client

pub fn get_acme_external_account_binding_credentials( &self, ) -> GetAcmeExternalAccountBindingCredentialsFluentBuilder

Constructs a fluent builder for the GetAcmeExternalAccountBindingCredentials operation.

• The fluent builder is configurable:
  • acme_external_account_binding_arn(impl Into<String>) / set_acme_external_account_binding_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME external account binding.

    
    
• On success, responds with GetAcmeExternalAccountBindingCredentialsOutput with field(s):
  • key_id(Option<String>):

    The key identifier for the external account binding credentials.

  • mac_key(Option<String>):

    The MAC key for the external account binding credentials.

• On failure, responds with SdkError<GetAcmeExternalAccountBindingCredentialsError>

impl Client

pub fn get_certificate(&self) -> GetCertificateFluentBuilder

Constructs a fluent builder for the GetCertificate operation.

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: true
    

    String that contains a certificate ARN in the following format:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    
    
• On success, responds with GetCertificateOutput with field(s):
  • certificate(Option<String>):

    The ACM-issued certificate corresponding to the ARN specified as input.

  • certificate_chain(Option<String>):

    Certificates forming the requested certificate’s chain of trust. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs.

• On failure, responds with SdkError<GetCertificateError>

impl Client

pub fn import_certificate(&self) -> ImportCertificateFluentBuilder

Constructs a fluent builder for the ImportCertificate operation.

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.

    
    
  • certificate(Blob) / set_certificate(Option<Blob>):
    required: true
    

    The certificate to import.

    
    
  • private_key(Blob) / set_private_key(Option<Blob>):
    required: true
    

    The private key that matches the public key in the certificate.

    
    
  • certificate_chain(Blob) / set_certificate_chain(Option<Blob>):
    required: false
    

    The PEM encoded certificate chain.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    One or more resource tags to associate with the imported certificate.

    Note: You cannot apply tags when reimporting a certificate.

    
    
• On success, responds with ImportCertificateOutput with field(s):
  • certificate_arn(Option<String>):

    The Amazon Resource Name (ARN) of the imported certificate.

• On failure, responds with SdkError<ImportCertificateError>

impl Client

pub fn list_acme_accounts(&self) -> ListAcmeAccountsFluentBuilder

Constructs a fluent builder for the ListAcmeAccounts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token for pagination.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • acme_endpoint_arn(impl Into<String>) / set_acme_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME endpoint.

    
    
• On success, responds with ListAcmeAccountsOutput with field(s):
  • acme_accounts(Option<Vec::<AcmeAccountSummary>>):

    The list of ACME accounts.

  • next_token(Option<String>):

    A token for pagination.

• On failure, responds with SdkError<ListAcmeAccountsError>

impl Client

pub fn list_acme_domain_validations( &self, ) -> ListAcmeDomainValidationsFluentBuilder

Constructs a fluent builder for the ListAcmeDomainValidations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token for pagination.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • acme_endpoint_arn(impl Into<String>) / set_acme_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME endpoint.

    
    
• On success, responds with ListAcmeDomainValidationsOutput with field(s):
  • acme_domain_validations(Option<Vec::<AcmeDomainValidationSummary>>):

    The list of domain validations.

  • next_token(Option<String>):

    A token for pagination.

• On failure, responds with SdkError<ListAcmeDomainValidationsError>

impl Client

pub fn list_acme_endpoints(&self) -> ListAcmeEndpointsFluentBuilder

Constructs a fluent builder for the ListAcmeEndpoints operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token for pagination.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
• On success, responds with ListAcmeEndpointsOutput with field(s):
  • acme_endpoints(Option<Vec::<AcmeEndpointSummary>>):

    The list of ACME endpoints.

  • next_token(Option<String>):

    A token for pagination.

• On failure, responds with SdkError<ListAcmeEndpointsError>

impl Client

pub fn list_acme_external_account_bindings( &self, ) -> ListAcmeExternalAccountBindingsFluentBuilder

Constructs a fluent builder for the ListAcmeExternalAccountBindings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token for pagination.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • acme_endpoint_arn(impl Into<String>) / set_acme_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME endpoint.

    
    
• On success, responds with ListAcmeExternalAccountBindingsOutput with field(s):
  • external_account_bindings(Option<Vec::<AcmeExternalAccountBindingSummary>>):

    The list of external account bindings.

  • next_token(Option<String>):

    A token for pagination.

• On failure, responds with SdkError<ListAcmeExternalAccountBindingsError>

impl Client

pub fn list_certificate_domain_validations( &self, ) -> ListCertificateDomainValidationsFluentBuilder

Constructs a fluent builder for the ListCertificateDomainValidations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the certificate for which to list domain validation summaries.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token returned by a previous call to ListCertificateDomainValidations. If the number of results exceeds MaxItems, use this token to retrieve the next page of results.

    
    
  • max_items(i32) / set_max_items(Option<i32>):
    required: false
    

    The maximum number of domain validation summaries to return. If you don’t specify a value, the default is 1000.

    
    
• On success, responds with ListCertificateDomainValidationsOutput with field(s):
  • domain_validation_summary_list(Option<Vec::<DomainValidationSummary>>):

    A list of DomainValidationSummary objects, one for each domain on the certificate. Each object contains the domain name and its active and requested validation configurations.

  • next_token(Option<String>):

    If the number of results exceeds MaxItems, this token is included in the response. Use this token in a subsequent ListCertificateDomainValidations request to retrieve the next page of results.

• On failure, responds with SdkError<ListCertificateDomainValidationsError>

impl Client

pub fn list_certificates(&self) -> ListCertificatesFluentBuilder

Constructs a fluent builder for the ListCertificates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • certificate_statuses(CertificateStatus) / set_certificate_statuses(Option<Vec::<CertificateStatus>>):
    required: false
    

    Filter the certificate list by status value.

    
    
  • certificate_key_pair_origins(CertificateKeyPairOrigin) / set_certificate_key_pair_origins(Option<Vec::<CertificateKeyPairOrigin>>):
    required: false
    

    Filter the certificate list by certificate key pair origin. Specify one or more CertificateKeyPairOrigin values. Default filtering returns only certificates with key pair origin of AWS_MANAGED and CUSTOMER_PROVIDED.

    
    
  • includes(Filters) / set_includes(Option<Filters>):
    required: false
    

    Filter the certificate list. For more information, see the Filters structure.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

    
    
  • max_items(i32) / set_max_items(Option<i32>):
    required: false
    

    Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

    
    
  • sort_by(SortBy) / set_sort_by(Option<SortBy>):
    required: false
    

    Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.

    
    
  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):
    required: false
    

    Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

    
    
• On success, responds with ListCertificatesOutput with field(s):
  • next_token(Option<String>):

    When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.

  • certificate_summary_list(Option<Vec::<CertificateSummary>>):

    A list of ACM certificates.

• On failure, responds with SdkError<ListCertificatesError>

impl Client

pub fn list_tags_for_certificate(&self) -> ListTagsForCertificateFluentBuilder

Constructs a fluent builder for the ListTagsForCertificate operation.

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: true
    

    String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    
    
• On success, responds with ListTagsForCertificateOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The key-value pairs that define the applied tags.

• On failure, responds with SdkError<ListTagsForCertificateError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the ACM resource for which to list tags.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The tags associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_account_configuration(&self) -> PutAccountConfigurationFluentBuilder

Constructs a fluent builder for the PutAccountConfiguration operation.

• The fluent builder is configurable:
  • expiry_events(ExpiryEventsConfiguration) / set_expiry_events(Option<ExpiryEventsConfiguration>):
    required: false
    

    Specifies expiration events associated with an account.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: true
    

    Customer-chosen string used to distinguish between calls to PutAccountConfiguration. Idempotency tokens time out after one hour. If you call PutAccountConfiguration multiple times with the same unexpired idempotency token, ACM treats it as the same request and returns the original result. If you change the idempotency token for each call, ACM treats each call as a new request.

    
    
• On success, responds with PutAccountConfigurationOutput
• On failure, responds with SdkError<PutAccountConfigurationError>

impl Client

pub fn remove_tags_from_certificate( &self, ) -> RemoveTagsFromCertificateFluentBuilder

Constructs a fluent builder for the RemoveTagsFromCertificate operation.

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: true
    

    String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The key-value pair that defines the tag to remove.

    
    
• On success, responds with RemoveTagsFromCertificateOutput
• On failure, responds with SdkError<RemoveTagsFromCertificateError>

impl Client

pub fn renew_certificate(&self) -> RenewCertificateFluentBuilder

Constructs a fluent builder for the RenewCertificate operation.

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: true
    

    String that contains the ARN of the ACM certificate to be renewed. This must be of the form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

    
    
• On success, responds with RenewCertificateOutput
• On failure, responds with SdkError<RenewCertificateError>

impl Client

pub fn request_certificate(&self) -> RequestCertificateFluentBuilder

Constructs a fluent builder for the RequestCertificate operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.

    In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.

    
    
  • validation_method(ValidationMethod) / set_validation_method(Option<ValidationMethod>):
    required: false
    

    The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.

    
    
  • subject_alternative_names(impl Into<String>) / set_subject_alternative_names(Option<Vec::<String>>):
    required: false
    

    Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

    The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:

    • (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.

    • (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.

    • (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: false
    

    Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.

    
    
  • domain_validation_options(DomainValidationOption) / set_domain_validation_options(Option<Vec::<DomainValidationOption>>):
    required: false
    

    The domain name that you want ACM to use to send you emails so that you can validate domain ownership.

    
    
  • options(CertificateOptions) / set_options(Option<CertificateOptions>):
    required: false
    

    You can use this parameter to specify whether to export your certificate.

    Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log. For more information, see Certificate Transparency Logging.

    You can export public ACM certificates to use with Amazon Web Services services as well as outside the Amazon Web Services Cloud. For more information, see Certificate Manager exportable public certificate.

    
    
  • certificate_authority_arn(impl Into<String>) / set_certificate_authority_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Amazon Web Services Private Certificate Authority user guide. The ARN must have the following form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    One or more resource tags to associate with the certificate.

    
    
  • key_algorithm(KeyAlgorithm) / set_key_algorithm(Option<KeyAlgorithm>):
    required: false
    

    Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms.

    Algorithms supported for an ACM certificate request include:

    • RSA_2048

    • EC_prime256v1

    • EC_secp384r1

    Other listed algorithms are for imported certificates only.

    When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA’s secret key.

    Default: RSA_2048

    
    
  • managed_by(CertificateManagedBy) / set_managed_by(Option<CertificateManagedBy>):
    required: false
    

    Identifies the Amazon Web Services service that manages the certificate issued by ACM.

    
    
• On success, responds with RequestCertificateOutput with field(s):
  • certificate_arn(Option<String>):

    String that contains the ARN of the issued certificate. This must be of the form:

    arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

• On failure, responds with SdkError<RequestCertificateError>

impl Client

pub fn resend_validation_email(&self) -> ResendValidationEmailFluentBuilder

Constructs a fluent builder for the ResendValidationEmail operation.

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: true
    

    String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the RequestCertificate action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form:

    arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: true
    

    The fully qualified domain name (FQDN) of the certificate that needs to be validated.

    
    
  • validation_domain(impl Into<String>) / set_validation_domain(Option<String>):
    required: true
    

    The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the Domain value or a superdomain of the Domain value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the the following five addresses:

    • admin@subdomain.example.com

    • administrator@subdomain.example.com

    • hostmaster@subdomain.example.com

    • postmaster@subdomain.example.com

    • webmaster@subdomain.example.com

    
    
• On success, responds with ResendValidationEmailOutput
• On failure, responds with SdkError<ResendValidationEmailError>

impl Client

pub fn revoke_acme_account(&self) -> RevokeAcmeAccountFluentBuilder

Constructs a fluent builder for the RevokeAcmeAccount operation.

• The fluent builder is configurable:
  • acme_endpoint_arn(impl Into<String>) / set_acme_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME endpoint.

    
    
  • account_url(impl Into<String>) / set_account_url(Option<String>):
    required: true
    

    The URL of the ACME account to revoke.

    
    
• On success, responds with RevokeAcmeAccountOutput
• On failure, responds with SdkError<RevokeAcmeAccountError>

impl Client

pub fn revoke_acme_external_account_binding( &self, ) -> RevokeAcmeExternalAccountBindingFluentBuilder

Constructs a fluent builder for the RevokeAcmeExternalAccountBinding operation.

• The fluent builder is configurable:
  • acme_external_account_binding_arn(impl Into<String>) / set_acme_external_account_binding_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME external account binding to revoke.

    
    
• On success, responds with RevokeAcmeExternalAccountBindingOutput
• On failure, responds with SdkError<RevokeAcmeExternalAccountBindingError>

impl Client

pub fn revoke_certificate(&self) -> RevokeCertificateFluentBuilder

Constructs a fluent builder for the RevokeCertificate operation.

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the public or private certificate that will be revoked. The ARN must have the following form:

    arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012

    
    
  • revocation_reason(RevocationReason) / set_revocation_reason(Option<RevocationReason>):
    required: true
    

    Specifies why you revoked the certificate.

    
    
• On success, responds with RevokeCertificateOutput with field(s):
  • certificate_arn(Option<String>):

    The Amazon Resource Name (ARN) of the public or private certificate that was revoked.

• On failure, responds with SdkError<RevokeCertificateError>

impl Client

pub fn search_certificates(&self) -> SearchCertificatesFluentBuilder

Constructs a fluent builder for the SearchCertificates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter_statement(CertificateFilterStatement) / set_filter_statement(Option<CertificateFilterStatement>):
    required: false
    

    A filter statement that defines the search criteria. You can combine multiple filters using AND, OR, and NOT logical operators to create complex queries.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response. Default is 100.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

    
    
  • sort_by(SearchCertificatesSortBy) / set_sort_by(Option<SearchCertificatesSortBy>):
    required: false
    

    Specifies the field to sort results by. Valid values are CREATED_AT, NOT_AFTER, STATUS, RENEWAL_STATUS, EXPORTED, IN_USE, NOT_BEFORE, KEY_ALGORITHM, TYPE, CERTIFICATE_ARN, COMMON_NAME, REVOKED_AT, RENEWAL_ELIGIBILITY, ISSUED_AT, MANAGED_BY, EXPORT_OPTION, VALIDATION_METHOD, and IMPORTED_AT.

    
    
  • sort_order(SearchCertificatesSortOrder) / set_sort_order(Option<SearchCertificatesSortOrder>):
    required: false
    

    Specifies the order of sorted results. Valid values are ASCENDING or DESCENDING.

    
    
• On success, responds with SearchCertificatesOutput with field(s):
  • results(Option<Vec::<CertificateSearchResult>>):

    A list of certificate search results containing certificate ARNs, X.509 attributes, and ACM metadata.

  • next_token(Option<String>):

    When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.

• On failure, responds with SdkError<SearchCertificatesError>

impl Client

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: true
    

    The ARN of the ACM resource to which the tag is to be applied.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The key-value pair that defines the tag to apply.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

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: true
    

    The ARN of the ACM resource from which the tag is to be removed.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The key of each tag to remove.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_acme_domain_validation( &self, ) -> UpdateAcmeDomainValidationFluentBuilder

Constructs a fluent builder for the UpdateAcmeDomainValidation operation.

• The fluent builder is configurable:
  • acme_domain_validation_arn(impl Into<String>) / set_acme_domain_validation_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME domain validation to update.

    
    
  • prevalidation_options(PrevalidationOptions) / set_prevalidation_options(Option<PrevalidationOptions>):
    required: false
    

    The updated prevalidation options.

    
    
• On success, responds with UpdateAcmeDomainValidationOutput
• On failure, responds with SdkError<UpdateAcmeDomainValidationError>

impl Client

pub fn update_acme_endpoint(&self) -> UpdateAcmeEndpointFluentBuilder

Constructs a fluent builder for the UpdateAcmeEndpoint operation.

• The fluent builder is configurable:
  • acme_endpoint_arn(impl Into<String>) / set_acme_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the ACME endpoint to update.

    
    
  • authorization_behavior(AcmeAuthorizationBehavior) / set_authorization_behavior(Option<AcmeAuthorizationBehavior>):
    required: false
    

    The updated authorization behavior.

    
    
  • contact(AcmeContact) / set_contact(Option<AcmeContact>):
    required: false
    

    The updated contact requirement.

    
    
  • certificate_authority(CertificateAuthority) / set_certificate_authority(Option<CertificateAuthority>):
    required: false
    

    The updated certificate authority configuration.

    
    
• On success, responds with UpdateAcmeEndpointOutput
• On failure, responds with SdkError<UpdateAcmeEndpointError>

impl Client

pub fn update_certificate_options( &self, ) -> UpdateCertificateOptionsFluentBuilder

Constructs a fluent builder for the UpdateCertificateOptions operation.

• The fluent builder is configurable:
  • certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
    required: true
    

    ARN of the requested certificate to update. This must be of the form:

    arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012

    
    
  • options(CertificateOptions) / set_options(Option<CertificateOptions>):
    required: true
    

    Use to update the options for your certificate. Currently, you can change the domain validation method or specify whether to export your certificate. For more information about migrating from email to DNS validation, see Migrate from email to DNS validation.

    
    
• On success, responds with UpdateCertificateOptionsOutput
• On failure, responds with SdkError<UpdateCertificateOptionsError>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_acme_domain_validation_validated( &self, ) -> AcmeDomainValidationValidatedFluentBuilder

Wait until an ACME domain validation reaches a terminal validation state.

fn wait_until_acme_domain_validation_deleted( &self, ) -> AcmeDomainValidationDeletedFluentBuilder

Wait until an ACME domain validation has been deleted.

fn wait_until_acme_endpoint_active(&self) -> AcmeEndpointActiveFluentBuilder

Wait until an ACME endpoint has finished provisioning and is ACTIVE.

fn wait_until_acme_endpoint_deleted(&self) -> AcmeEndpointDeletedFluentBuilder

Wait until an ACME endpoint has been deleted.

fn wait_until_certificate_validated(&self) -> CertificateValidatedFluentBuilder

Wait for certificate_validated