Skip to content

ACMClient#

Index > ACM > ACMClient

Auto-generated documentation for ACM type annotations stubs module mypy-boto3-acm.

ACMClient#

Type annotations and code completion for boto3.client("acm"). boto3 documentation

# ACMClient usage example

from boto3.session import Session
from mypy_boto3_acm.client import ACMClient

def get_acm_client() -> ACMClient:
    return Session().client("acm")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("acm").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("acm")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidArgsException,
    client.exceptions.InvalidArnException,
    client.exceptions.InvalidDomainValidationOptionsException,
    client.exceptions.InvalidParameterException,
    client.exceptions.InvalidStateException,
    client.exceptions.InvalidTagException,
    client.exceptions.LimitExceededException,
    client.exceptions.RequestInProgressException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.TagPolicyException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyTagsException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_acm.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("acm").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("acm").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

add_tags_to_certificate#

Adds one or more tags to an ACM certificate.

Type annotations and code completion for boto3.client("acm").add_tags_to_certificate method. boto3 documentation

# add_tags_to_certificate method definition

def add_tags_to_certificate(
    self,
    *,
    CertificateArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See EmptyResponseMetadataTypeDef
# add_tags_to_certificate method usage example with argument unpacking

kwargs: AddTagsToCertificateRequestTypeDef = {  # (1)
    "CertificateArn": ...,
    "Tags": ...,
}

parent.add_tags_to_certificate(**kwargs)
  1. See AddTagsToCertificateRequestTypeDef

create_acme_domain_validation#

Creates a domain validation for an ACME endpoint.

Type annotations and code completion for boto3.client("acm").create_acme_domain_validation method. boto3 documentation

# create_acme_domain_validation method definition

def create_acme_domain_validation(
    self,
    *,
    AcmeEndpointArn: str,
    DomainName: str,
    PrevalidationOptions: PrevalidationOptionsTypeDef,  # (1)
    IdempotencyToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateAcmeDomainValidationResponseTypeDef:  # (3)
    ...
  1. See PrevalidationOptionsTypeDef
  2. See Sequence[TagTypeDef]
  3. See CreateAcmeDomainValidationResponseTypeDef
# create_acme_domain_validation method usage example with argument unpacking

kwargs: CreateAcmeDomainValidationRequestTypeDef = {  # (1)
    "AcmeEndpointArn": ...,
    "DomainName": ...,
    "PrevalidationOptions": ...,
}

parent.create_acme_domain_validation(**kwargs)
  1. See CreateAcmeDomainValidationRequestTypeDef

create_acme_endpoint#

Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL.

Type annotations and code completion for boto3.client("acm").create_acme_endpoint method. boto3 documentation

# create_acme_endpoint method definition

def create_acme_endpoint(
    self,
    *,
    AuthorizationBehavior: AcmeAuthorizationBehaviorType,  # (1)
    CertificateAuthority: CertificateAuthorityUnionTypeDef,  # (2)
    IdempotencyToken: str = ...,
    Contact: AcmeContactType = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    CertificateTags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateAcmeEndpointResponseTypeDef:  # (6)
    ...
  1. See AcmeAuthorizationBehaviorType
  2. See CertificateAuthorityUnionTypeDef
  3. See AcmeContactType
  4. See Sequence[TagTypeDef]
  5. See Sequence[TagTypeDef]
  6. See CreateAcmeEndpointResponseTypeDef
# create_acme_endpoint method usage example with argument unpacking

kwargs: CreateAcmeEndpointRequestTypeDef = {  # (1)
    "AuthorizationBehavior": ...,
    "CertificateAuthority": ...,
}

parent.create_acme_endpoint(**kwargs)
  1. See CreateAcmeEndpointRequestTypeDef

create_acme_external_account_binding#

Creates an external account binding (EAB) for an ACME endpoint.

Type annotations and code completion for boto3.client("acm").create_acme_external_account_binding method. boto3 documentation

# create_acme_external_account_binding method definition

def create_acme_external_account_binding(
    self,
    *,
    AcmeEndpointArn: str,
    RoleArn: str,
    IdempotencyToken: str = ...,
    Expiration: ExpirationTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateAcmeExternalAccountBindingResponseTypeDef:  # (3)
    ...
  1. See ExpirationTypeDef
  2. See Sequence[TagTypeDef]
  3. See CreateAcmeExternalAccountBindingResponseTypeDef
# create_acme_external_account_binding method usage example with argument unpacking

kwargs: CreateAcmeExternalAccountBindingRequestTypeDef = {  # (1)
    "AcmeEndpointArn": ...,
    "RoleArn": ...,
}

parent.create_acme_external_account_binding(**kwargs)
  1. See CreateAcmeExternalAccountBindingRequestTypeDef

delete_acme_domain_validation#

Deletes a domain validation.

Type annotations and code completion for boto3.client("acm").delete_acme_domain_validation method. boto3 documentation

# delete_acme_domain_validation method definition

def delete_acme_domain_validation(
    self,
    *,
    AcmeDomainValidationArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_acme_domain_validation method usage example with argument unpacking

kwargs: DeleteAcmeDomainValidationRequestTypeDef = {  # (1)
    "AcmeDomainValidationArn": ...,
}

parent.delete_acme_domain_validation(**kwargs)
  1. See DeleteAcmeDomainValidationRequestTypeDef

delete_acme_endpoint#

Deletes an ACME endpoint.

Type annotations and code completion for boto3.client("acm").delete_acme_endpoint method. boto3 documentation

# delete_acme_endpoint method definition

def delete_acme_endpoint(
    self,
    *,
    AcmeEndpointArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_acme_endpoint method usage example with argument unpacking

kwargs: DeleteAcmeEndpointRequestTypeDef = {  # (1)
    "AcmeEndpointArn": ...,
}

parent.delete_acme_endpoint(**kwargs)
  1. See DeleteAcmeEndpointRequestTypeDef

delete_acme_external_account_binding#

Deletes an external account binding.

Type annotations and code completion for boto3.client("acm").delete_acme_external_account_binding method. boto3 documentation

# delete_acme_external_account_binding method definition

def delete_acme_external_account_binding(
    self,
    *,
    AcmeExternalAccountBindingArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_acme_external_account_binding method usage example with argument unpacking

kwargs: DeleteAcmeExternalAccountBindingRequestTypeDef = {  # (1)
    "AcmeExternalAccountBindingArn": ...,
}

parent.delete_acme_external_account_binding(**kwargs)
  1. See DeleteAcmeExternalAccountBindingRequestTypeDef

delete_certificate#

Deletes a certificate and its associated private key.

Type annotations and code completion for boto3.client("acm").delete_certificate method. boto3 documentation

# delete_certificate method definition

def delete_certificate(
    self,
    *,
    CertificateArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_certificate method usage example with argument unpacking

kwargs: DeleteCertificateRequestTypeDef = {  # (1)
    "CertificateArn": ...,
}

parent.delete_certificate(**kwargs)
  1. See DeleteCertificateRequestTypeDef

describe_acme_account#

Returns detailed metadata about the specified ACME account, including its status, public key thumbprint, and associated external account binding.

Type annotations and code completion for boto3.client("acm").describe_acme_account method. boto3 documentation

# describe_acme_account method definition

def describe_acme_account(
    self,
    *,
    AcmeEndpointArn: str,
    AccountUrl: str,
) -> DescribeAcmeAccountResponseTypeDef:  # (1)
    ...
  1. See DescribeAcmeAccountResponseTypeDef
# describe_acme_account method usage example with argument unpacking

kwargs: DescribeAcmeAccountRequestTypeDef = {  # (1)
    "AcmeEndpointArn": ...,
    "AccountUrl": ...,
}

parent.describe_acme_account(**kwargs)
  1. See DescribeAcmeAccountRequestTypeDef

describe_acme_domain_validation#

Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation.

Type annotations and code completion for boto3.client("acm").describe_acme_domain_validation method. boto3 documentation

# describe_acme_domain_validation method definition

def describe_acme_domain_validation(
    self,
    *,
    AcmeDomainValidationArn: str,
) -> DescribeAcmeDomainValidationResponseTypeDef:  # (1)
    ...
  1. See DescribeAcmeDomainValidationResponseTypeDef
# describe_acme_domain_validation method usage example with argument unpacking

kwargs: DescribeAcmeDomainValidationRequestTypeDef = {  # (1)
    "AcmeDomainValidationArn": ...,
}

parent.describe_acme_domain_validation(**kwargs)
  1. See DescribeAcmeDomainValidationRequestTypeDef

describe_acme_endpoint#

Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration.

Type annotations and code completion for boto3.client("acm").describe_acme_endpoint method. boto3 documentation

# describe_acme_endpoint method definition

def describe_acme_endpoint(
    self,
    *,
    AcmeEndpointArn: str,
) -> DescribeAcmeEndpointResponseTypeDef:  # (1)
    ...
  1. See DescribeAcmeEndpointResponseTypeDef
# describe_acme_endpoint method usage example with argument unpacking

kwargs: DescribeAcmeEndpointRequestTypeDef = {  # (1)
    "AcmeEndpointArn": ...,
}

parent.describe_acme_endpoint(**kwargs)
  1. See DescribeAcmeEndpointRequestTypeDef

describe_acme_external_account_binding#

Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history.

Type annotations and code completion for boto3.client("acm").describe_acme_external_account_binding method. boto3 documentation

# describe_acme_external_account_binding method definition

def describe_acme_external_account_binding(
    self,
    *,
    AcmeExternalAccountBindingArn: str,
) -> DescribeAcmeExternalAccountBindingResponseTypeDef:  # (1)
    ...
  1. See DescribeAcmeExternalAccountBindingResponseTypeDef
# describe_acme_external_account_binding method usage example with argument unpacking

kwargs: DescribeAcmeExternalAccountBindingRequestTypeDef = {  # (1)
    "AcmeExternalAccountBindingArn": ...,
}

parent.describe_acme_external_account_binding(**kwargs)
  1. See DescribeAcmeExternalAccountBindingRequestTypeDef

describe_certificate#

Returns detailed metadata about the specified ACM certificate.

Type annotations and code completion for boto3.client("acm").describe_certificate method. boto3 documentation

# describe_certificate method definition

def describe_certificate(
    self,
    *,
    CertificateArn: str,
) -> DescribeCertificateResponseTypeDef:  # (1)
    ...
  1. See DescribeCertificateResponseTypeDef
# describe_certificate method usage example with argument unpacking

kwargs: DescribeCertificateRequestTypeDef = {  # (1)
    "CertificateArn": ...,
}

parent.describe_certificate(**kwargs)
  1. See DescribeCertificateRequestTypeDef

export_certificate#

Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere.

Type annotations and code completion for boto3.client("acm").export_certificate method. boto3 documentation

# export_certificate method definition

def export_certificate(
    self,
    *,
    CertificateArn: str,
    Passphrase: BlobTypeDef,
) -> ExportCertificateResponseTypeDef:  # (1)
    ...
  1. See ExportCertificateResponseTypeDef
# export_certificate method usage example with argument unpacking

kwargs: ExportCertificateRequestTypeDef = {  # (1)
    "CertificateArn": ...,
    "Passphrase": ...,
}

parent.export_certificate(**kwargs)
  1. See ExportCertificateRequestTypeDef

get_account_configuration#

Returns the account configuration options associated with an Amazon Web Services account.

Type annotations and code completion for boto3.client("acm").get_account_configuration method. boto3 documentation

# get_account_configuration method definition

def get_account_configuration(
    self,
) -> GetAccountConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetAccountConfigurationResponseTypeDef

get_acme_external_account_binding_credentials#

Retrieves the key ID and MAC key credentials for an external account binding.

Type annotations and code completion for boto3.client("acm").get_acme_external_account_binding_credentials method. boto3 documentation

# get_acme_external_account_binding_credentials method definition

def get_acme_external_account_binding_credentials(
    self,
    *,
    AcmeExternalAccountBindingArn: str,
) -> GetAcmeExternalAccountBindingCredentialsResponseTypeDef:  # (1)
    ...
  1. See GetAcmeExternalAccountBindingCredentialsResponseTypeDef
# get_acme_external_account_binding_credentials method usage example with argument unpacking

kwargs: GetAcmeExternalAccountBindingCredentialsRequestTypeDef = {  # (1)
    "AcmeExternalAccountBindingArn": ...,
}

parent.get_acme_external_account_binding_credentials(**kwargs)
  1. See GetAcmeExternalAccountBindingCredentialsRequestTypeDef

get_certificate#

Retrieves a certificate and its certificate chain.

Type annotations and code completion for boto3.client("acm").get_certificate method. boto3 documentation

# get_certificate method definition

def get_certificate(
    self,
    *,
    CertificateArn: str,
) -> GetCertificateResponseTypeDef:  # (1)
    ...
  1. See GetCertificateResponseTypeDef
# get_certificate method usage example with argument unpacking

kwargs: GetCertificateRequestTypeDef = {  # (1)
    "CertificateArn": ...,
}

parent.get_certificate(**kwargs)
  1. See GetCertificateRequestTypeDef

import_certificate#

Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.

Type annotations and code completion for boto3.client("acm").import_certificate method. boto3 documentation

# import_certificate method definition

def import_certificate(
    self,
    *,
    Certificate: BlobTypeDef,
    PrivateKey: BlobTypeDef,
    CertificateArn: str = ...,
    CertificateChain: BlobTypeDef = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> ImportCertificateResponseTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See ImportCertificateResponseTypeDef
# import_certificate method usage example with argument unpacking

kwargs: ImportCertificateRequestTypeDef = {  # (1)
    "Certificate": ...,
    "PrivateKey": ...,
}

parent.import_certificate(**kwargs)
  1. See ImportCertificateRequestTypeDef

list_acme_accounts#

Retrieves a list of ACME accounts registered with the specified ACME endpoint.

Type annotations and code completion for boto3.client("acm").list_acme_accounts method. boto3 documentation

# list_acme_accounts method definition

def list_acme_accounts(
    self,
    *,
    AcmeEndpointArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAcmeAccountsResponseTypeDef:  # (1)
    ...
  1. See ListAcmeAccountsResponseTypeDef
# list_acme_accounts method usage example with argument unpacking

kwargs: ListAcmeAccountsRequestTypeDef = {  # (1)
    "AcmeEndpointArn": ...,
}

parent.list_acme_accounts(**kwargs)
  1. See ListAcmeAccountsRequestTypeDef

list_acme_domain_validations#

Retrieves a list of domain validations for the specified ACME endpoint.

Type annotations and code completion for boto3.client("acm").list_acme_domain_validations method. boto3 documentation

# list_acme_domain_validations method definition

def list_acme_domain_validations(
    self,
    *,
    AcmeEndpointArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAcmeDomainValidationsResponseTypeDef:  # (1)
    ...
  1. See ListAcmeDomainValidationsResponseTypeDef
# list_acme_domain_validations method usage example with argument unpacking

kwargs: ListAcmeDomainValidationsRequestTypeDef = {  # (1)
    "AcmeEndpointArn": ...,
}

parent.list_acme_domain_validations(**kwargs)
  1. See ListAcmeDomainValidationsRequestTypeDef

list_acme_endpoints#

Retrieves a list of ACME endpoints in your account.

Type annotations and code completion for boto3.client("acm").list_acme_endpoints method. boto3 documentation

# list_acme_endpoints method definition

def list_acme_endpoints(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAcmeEndpointsResponseTypeDef:  # (1)
    ...
  1. See ListAcmeEndpointsResponseTypeDef
# list_acme_endpoints method usage example with argument unpacking

kwargs: ListAcmeEndpointsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_acme_endpoints(**kwargs)
  1. See ListAcmeEndpointsRequestTypeDef

list_acme_external_account_bindings#

Retrieves a list of external account bindings for the specified ACME endpoint.

Type annotations and code completion for boto3.client("acm").list_acme_external_account_bindings method. boto3 documentation

# list_acme_external_account_bindings method definition

def list_acme_external_account_bindings(
    self,
    *,
    AcmeEndpointArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAcmeExternalAccountBindingsResponseTypeDef:  # (1)
    ...
  1. See ListAcmeExternalAccountBindingsResponseTypeDef
# list_acme_external_account_bindings method usage example with argument unpacking

kwargs: ListAcmeExternalAccountBindingsRequestTypeDef = {  # (1)
    "AcmeEndpointArn": ...,
}

parent.list_acme_external_account_bindings(**kwargs)
  1. See ListAcmeExternalAccountBindingsRequestTypeDef

list_certificates#

Retrieves a list of certificate ARNs and domain names.

Type annotations and code completion for boto3.client("acm").list_certificates method. boto3 documentation

# list_certificates method definition

def list_certificates(
    self,
    *,
    CertificateStatuses: Sequence[CertificateStatusType] = ...,  # (1)
    CertificateKeyPairOrigins: Sequence[CertificateKeyPairOriginType] = ...,  # (2)
    Includes: FiltersTypeDef = ...,  # (3)
    NextToken: str = ...,
    MaxItems: int = ...,
    SortBy: SortByType = ...,  # (4)
    SortOrder: SortOrderType = ...,  # (5)
) -> ListCertificatesResponseTypeDef:  # (6)
    ...
  1. See Sequence[CertificateStatusType]
  2. See Sequence[CertificateKeyPairOriginType]
  3. See FiltersTypeDef
  4. See SortByType
  5. See SortOrderType
  6. See ListCertificatesResponseTypeDef
# list_certificates method usage example with argument unpacking

kwargs: ListCertificatesRequestTypeDef = {  # (1)
    "CertificateStatuses": ...,
}

parent.list_certificates(**kwargs)
  1. See ListCertificatesRequestTypeDef

list_tags_for_certificate#

Lists the tags that have been applied to the ACM certificate.

Type annotations and code completion for boto3.client("acm").list_tags_for_certificate method. boto3 documentation

# list_tags_for_certificate method definition

def list_tags_for_certificate(
    self,
    *,
    CertificateArn: str,
) -> ListTagsForCertificateResponseTypeDef:  # (1)
    ...
  1. See ListTagsForCertificateResponseTypeDef
# list_tags_for_certificate method usage example with argument unpacking

kwargs: ListTagsForCertificateRequestTypeDef = {  # (1)
    "CertificateArn": ...,
}

parent.list_tags_for_certificate(**kwargs)
  1. See ListTagsForCertificateRequestTypeDef

list_tags_for_resource#

Lists the tags associated with an ACM resource.

Type annotations and code completion for boto3.client("acm").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

put_account_configuration#

Adds or modifies account-level configurations in ACM.

Type annotations and code completion for boto3.client("acm").put_account_configuration method. boto3 documentation

# put_account_configuration method definition

def put_account_configuration(
    self,
    *,
    IdempotencyToken: str,
    ExpiryEvents: ExpiryEventsConfigurationTypeDef = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See ExpiryEventsConfigurationTypeDef
  2. See EmptyResponseMetadataTypeDef
# put_account_configuration method usage example with argument unpacking

kwargs: PutAccountConfigurationRequestTypeDef = {  # (1)
    "IdempotencyToken": ...,
}

parent.put_account_configuration(**kwargs)
  1. See PutAccountConfigurationRequestTypeDef

remove_tags_from_certificate#

Remove one or more tags from an ACM certificate.

Type annotations and code completion for boto3.client("acm").remove_tags_from_certificate method. boto3 documentation

# remove_tags_from_certificate method definition

def remove_tags_from_certificate(
    self,
    *,
    CertificateArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See EmptyResponseMetadataTypeDef
# remove_tags_from_certificate method usage example with argument unpacking

kwargs: RemoveTagsFromCertificateRequestTypeDef = {  # (1)
    "CertificateArn": ...,
    "Tags": ...,
}

parent.remove_tags_from_certificate(**kwargs)
  1. See RemoveTagsFromCertificateRequestTypeDef

renew_certificate#

Renews an eligible ACM certificate.

Type annotations and code completion for boto3.client("acm").renew_certificate method. boto3 documentation

# renew_certificate method definition

def renew_certificate(
    self,
    *,
    CertificateArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# renew_certificate method usage example with argument unpacking

kwargs: RenewCertificateRequestTypeDef = {  # (1)
    "CertificateArn": ...,
}

parent.renew_certificate(**kwargs)
  1. See RenewCertificateRequestTypeDef

request_certificate#

Requests an ACM certificate for use with other Amazon Web Services services.

Type annotations and code completion for boto3.client("acm").request_certificate method. boto3 documentation

# request_certificate method definition

def request_certificate(
    self,
    *,
    DomainName: str,
    ValidationMethod: ValidationMethodType = ...,  # (1)
    SubjectAlternativeNames: Sequence[str] = ...,
    IdempotencyToken: str = ...,
    DomainValidationOptions: Sequence[DomainValidationOptionTypeDef] = ...,  # (2)
    Options: CertificateOptionsTypeDef = ...,  # (3)
    CertificateAuthorityArn: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    KeyAlgorithm: KeyAlgorithmType = ...,  # (5)
    ManagedBy: CertificateManagedByType = ...,  # (6)
) -> RequestCertificateResponseTypeDef:  # (7)
    ...
  1. See ValidationMethodType
  2. See Sequence[DomainValidationOptionTypeDef]
  3. See CertificateOptionsTypeDef
  4. See Sequence[TagTypeDef]
  5. See KeyAlgorithmType
  6. See CertificateManagedByType
  7. See RequestCertificateResponseTypeDef
# request_certificate method usage example with argument unpacking

kwargs: RequestCertificateRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.request_certificate(**kwargs)
  1. See RequestCertificateRequestTypeDef

resend_validation_email#

Resends the email that requests domain ownership validation.

Type annotations and code completion for boto3.client("acm").resend_validation_email method. boto3 documentation

# resend_validation_email method definition

def resend_validation_email(
    self,
    *,
    CertificateArn: str,
    Domain: str,
    ValidationDomain: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# resend_validation_email method usage example with argument unpacking

kwargs: ResendValidationEmailRequestTypeDef = {  # (1)
    "CertificateArn": ...,
    "Domain": ...,
    "ValidationDomain": ...,
}

parent.resend_validation_email(**kwargs)
  1. See ResendValidationEmailRequestTypeDef

revoke_acme_account#

Revokes an ACME account, preventing it from requesting or revoking certificates.

Type annotations and code completion for boto3.client("acm").revoke_acme_account method. boto3 documentation

# revoke_acme_account method definition

def revoke_acme_account(
    self,
    *,
    AcmeEndpointArn: str,
    AccountUrl: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# revoke_acme_account method usage example with argument unpacking

kwargs: RevokeAcmeAccountRequestTypeDef = {  # (1)
    "AcmeEndpointArn": ...,
    "AccountUrl": ...,
}

parent.revoke_acme_account(**kwargs)
  1. See RevokeAcmeAccountRequestTypeDef

revoke_acme_external_account_binding#

Revokes an external account binding, preventing new ACME accounts from being registered using this binding.

Type annotations and code completion for boto3.client("acm").revoke_acme_external_account_binding method. boto3 documentation

# revoke_acme_external_account_binding method definition

def revoke_acme_external_account_binding(
    self,
    *,
    AcmeExternalAccountBindingArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# revoke_acme_external_account_binding method usage example with argument unpacking

kwargs: RevokeAcmeExternalAccountBindingRequestTypeDef = {  # (1)
    "AcmeExternalAccountBindingArn": ...,
}

parent.revoke_acme_external_account_binding(**kwargs)
  1. See RevokeAcmeExternalAccountBindingRequestTypeDef

revoke_certificate#

Revokes a public ACM certificate.

Type annotations and code completion for boto3.client("acm").revoke_certificate method. boto3 documentation

# revoke_certificate method definition

def revoke_certificate(
    self,
    *,
    CertificateArn: str,
    RevocationReason: RevocationReasonType,  # (1)
) -> RevokeCertificateResponseTypeDef:  # (2)
    ...
  1. See RevocationReasonType
  2. See RevokeCertificateResponseTypeDef
# revoke_certificate method usage example with argument unpacking

kwargs: RevokeCertificateRequestTypeDef = {  # (1)
    "CertificateArn": ...,
    "RevocationReason": ...,
}

parent.revoke_certificate(**kwargs)
  1. See RevokeCertificateRequestTypeDef

search_certificates#

Retrieves a list of certificates matching search criteria.

Type annotations and code completion for boto3.client("acm").search_certificates method. boto3 documentation

# search_certificates method definition

def search_certificates(
    self,
    *,
    FilterStatement: CertificateFilterStatementTypeDef = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: SearchCertificatesSortByType = ...,  # (2)
    SortOrder: SearchCertificatesSortOrderType = ...,  # (3)
) -> SearchCertificatesResponseTypeDef:  # (4)
    ...
  1. See CertificateFilterStatementTypeDef
  2. See SearchCertificatesSortByType
  3. See SearchCertificatesSortOrderType
  4. See SearchCertificatesResponseTypeDef
# search_certificates method usage example with argument unpacking

kwargs: SearchCertificatesRequestTypeDef = {  # (1)
    "FilterStatement": ...,
}

parent.search_certificates(**kwargs)
  1. See SearchCertificatesRequestTypeDef

tag_resource#

Adds one or more tags to an ACM resource.

Type annotations and code completion for boto3.client("acm").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See EmptyResponseMetadataTypeDef
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes one or more tags from an ACM resource.

Type annotations and code completion for boto3.client("acm").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_acme_domain_validation#

Updates the prevalidation configuration of an existing domain validation.

Type annotations and code completion for boto3.client("acm").update_acme_domain_validation method. boto3 documentation

# update_acme_domain_validation method definition

def update_acme_domain_validation(
    self,
    *,
    AcmeDomainValidationArn: str,
    PrevalidationOptions: PrevalidationOptionsTypeDef = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See PrevalidationOptionsTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_acme_domain_validation method usage example with argument unpacking

kwargs: UpdateAcmeDomainValidationRequestTypeDef = {  # (1)
    "AcmeDomainValidationArn": ...,
}

parent.update_acme_domain_validation(**kwargs)
  1. See UpdateAcmeDomainValidationRequestTypeDef

update_acme_endpoint#

Updates the configuration of an existing ACME endpoint.

Type annotations and code completion for boto3.client("acm").update_acme_endpoint method. boto3 documentation

# update_acme_endpoint method definition

def update_acme_endpoint(
    self,
    *,
    AcmeEndpointArn: str,
    AuthorizationBehavior: AcmeAuthorizationBehaviorType = ...,  # (1)
    Contact: AcmeContactType = ...,  # (2)
    CertificateAuthority: CertificateAuthorityUnionTypeDef = ...,  # (3)
) -> EmptyResponseMetadataTypeDef:  # (4)
    ...
  1. See AcmeAuthorizationBehaviorType
  2. See AcmeContactType
  3. See CertificateAuthorityUnionTypeDef
  4. See EmptyResponseMetadataTypeDef
# update_acme_endpoint method usage example with argument unpacking

kwargs: UpdateAcmeEndpointRequestTypeDef = {  # (1)
    "AcmeEndpointArn": ...,
}

parent.update_acme_endpoint(**kwargs)
  1. See UpdateAcmeEndpointRequestTypeDef

update_certificate_options#

Updates a certificate.

Type annotations and code completion for boto3.client("acm").update_certificate_options method. boto3 documentation

# update_certificate_options method definition

def update_certificate_options(
    self,
    *,
    CertificateArn: str,
    Options: CertificateOptionsTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See CertificateOptionsTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_certificate_options method usage example with argument unpacking

kwargs: UpdateCertificateOptionsRequestTypeDef = {  # (1)
    "CertificateArn": ...,
    "Options": ...,
}

parent.update_certificate_options(**kwargs)
  1. See UpdateCertificateOptionsRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("acm").get_paginator method with overloads.

get_waiter#

Type annotations and code completion for boto3.client("acm").get_waiter method with overloads.