Skip to content

ACMClient#

Index > ACM > ACMClient

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

ACMClient#

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

# ACMClient usage example

from boto3.session import Session
from types_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.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.TagPolicyException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyTagsException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_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

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_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 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_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_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)
    Includes: FiltersTypeDef = ...,  # (2)
    NextToken: str = ...,
    MaxItems: int = ...,
    SortBy: SortByType = ...,  # (3)
    SortOrder: SortOrderType = ...,  # (4)
) -> ListCertificatesResponseTypeDef:  # (5)
    ...
  1. See Sequence[CertificateStatusType]
  2. See FiltersTypeDef
  3. See SortByType
  4. See SortOrderType
  5. 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

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_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

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.