ACMClient
Auto-generated documentation for ACM type annotations stubs module types-aiobotocore-acm.
ACMClient
Type annotations and code completion for session.client("acm")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_acm.client import ACMClient
session = Session()
async with session.client("acm") as client:
client: ACMClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("acm").exceptions
structure.
async with session.client("acm") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InvalidArgsException,
client.InvalidArnException,
client.InvalidDomainValidationOptionsException,
client.InvalidParameterException,
client.InvalidStateException,
client.InvalidTagException,
client.LimitExceededException,
client.RequestInProgressException,
client.ResourceInUseException,
client.ResourceNotFoundException,
client.TagPolicyException,
client.ThrottlingException,
client.TooManyTagsException,
client.ValidationException,
) as e:
print(e)
from types_aiobotocore_acm.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
add_tags_to_certificate
Adds one or more tags to an ACM certificate.
Type annotations and code completion for session.client("acm").add_tags_to_certificate
method.
boto3 documentation
await def add_tags_to_certificate(
self,
*,
CertificateArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: AddTagsToCertificateRequestRequestTypeDef = { # (1)
"CertificateArn": ...,
"Tags": ...,
}
parent.add_tags_to_certificate(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("acm").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("acm").close
method.
boto3 documentation
delete_certificate
Deletes a certificate and its associated private key.
Type annotations and code completion for session.client("acm").delete_certificate
method.
boto3 documentation
await def delete_certificate(
self,
*,
CertificateArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteCertificateRequestRequestTypeDef = { # (1)
"CertificateArn": ...,
}
parent.delete_certificate(**kwargs)
describe_certificate
Returns detailed metadata about the specified ACM certificate.
Type annotations and code completion for session.client("acm").describe_certificate
method.
boto3 documentation
await def describe_certificate(
self,
*,
CertificateArn: str,
) -> DescribeCertificateResponseTypeDef: # (1)
...
kwargs: DescribeCertificateRequestRequestTypeDef = { # (1)
"CertificateArn": ...,
}
parent.describe_certificate(**kwargs)
export_certificate
Exports a private certificate issued by a private certificate authority (CA) for use anywhere.
Type annotations and code completion for session.client("acm").export_certificate
method.
boto3 documentation
await def export_certificate(
self,
*,
CertificateArn: str,
Passphrase: Union[str, bytes, IO[Any], StreamingBody],
) -> ExportCertificateResponseTypeDef: # (1)
...
kwargs: ExportCertificateRequestRequestTypeDef = { # (1)
"CertificateArn": ...,
"Passphrase": ...,
}
parent.export_certificate(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("acm").generate_presigned_url
method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_account_configuration
Returns the account configuration options associated with an Amazon Web Services account.
Type annotations and code completion for session.client("acm").get_account_configuration
method.
boto3 documentation
await def get_account_configuration(
self,
) -> GetAccountConfigurationResponseTypeDef: # (1)
...
get_certificate
Retrieves an Amazon-issued certificate and its certificate chain.
Type annotations and code completion for session.client("acm").get_certificate
method.
boto3 documentation
await def get_certificate(
self,
*,
CertificateArn: str,
) -> GetCertificateResponseTypeDef: # (1)
...
kwargs: GetCertificateRequestRequestTypeDef = { # (1)
"CertificateArn": ...,
}
parent.get_certificate(**kwargs)
import_certificate
Imports a certificate into Amazon Web Services Certificate Manager (ACM) to use with services that are integrated with ACM.
Type annotations and code completion for session.client("acm").import_certificate
method.
boto3 documentation
await def import_certificate(
self,
*,
Certificate: Union[str, bytes, IO[Any], StreamingBody],
PrivateKey: Union[str, bytes, IO[Any], StreamingBody],
CertificateArn: str = ...,
CertificateChain: Union[str, bytes, IO[Any], StreamingBody] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> ImportCertificateResponseTypeDef: # (2)
...
kwargs: ImportCertificateRequestRequestTypeDef = { # (1)
"Certificate": ...,
"PrivateKey": ...,
}
parent.import_certificate(**kwargs)
list_certificates
Retrieves a list of certificate ARNs and domain names.
Type annotations and code completion for session.client("acm").list_certificates
method.
boto3 documentation
await def list_certificates(
self,
*,
CertificateStatuses: Sequence[CertificateStatusType] = ..., # (1)
Includes: FiltersTypeDef = ..., # (2)
NextToken: str = ...,
MaxItems: int = ...,
) -> ListCertificatesResponseTypeDef: # (3)
...
kwargs: ListCertificatesRequestRequestTypeDef = { # (1)
"CertificateStatuses": ...,
}
parent.list_certificates(**kwargs)
list_tags_for_certificate
Lists the tags that have been applied to the ACM certificate.
Type annotations and code completion for session.client("acm").list_tags_for_certificate
method.
boto3 documentation
await def list_tags_for_certificate(
self,
*,
CertificateArn: str,
) -> ListTagsForCertificateResponseTypeDef: # (1)
...
kwargs: ListTagsForCertificateRequestRequestTypeDef = { # (1)
"CertificateArn": ...,
}
parent.list_tags_for_certificate(**kwargs)
put_account_configuration
Adds or modifies account-level configurations in ACM.
Type annotations and code completion for session.client("acm").put_account_configuration
method.
boto3 documentation
await def put_account_configuration(
self,
*,
IdempotencyToken: str,
ExpiryEvents: ExpiryEventsConfigurationTypeDef = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: PutAccountConfigurationRequestRequestTypeDef = { # (1)
"IdempotencyToken": ...,
}
parent.put_account_configuration(**kwargs)
remove_tags_from_certificate
Remove one or more tags from an ACM certificate.
Type annotations and code completion for session.client("acm").remove_tags_from_certificate
method.
boto3 documentation
await def remove_tags_from_certificate(
self,
*,
CertificateArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: RemoveTagsFromCertificateRequestRequestTypeDef = { # (1)
"CertificateArn": ...,
"Tags": ...,
}
parent.remove_tags_from_certificate(**kwargs)
renew_certificate
Renews an eligible ACM certificate.
Type annotations and code completion for session.client("acm").renew_certificate
method.
boto3 documentation
await def renew_certificate(
self,
*,
CertificateArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: RenewCertificateRequestRequestTypeDef = { # (1)
"CertificateArn": ...,
}
parent.renew_certificate(**kwargs)
request_certificate
Requests an ACM certificate for use with other Amazon Web Services services.
Type annotations and code completion for session.client("acm").request_certificate
method.
boto3 documentation
await 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)
) -> RequestCertificateResponseTypeDef: # (5)
...
- See ValidationMethodType
- See DomainValidationOptionTypeDef
- See CertificateOptionsTypeDef
- See TagTypeDef
- See RequestCertificateResponseTypeDef
kwargs: RequestCertificateRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.request_certificate(**kwargs)
resend_validation_email
Resends the email that requests domain ownership validation.
Type annotations and code completion for session.client("acm").resend_validation_email
method.
boto3 documentation
await def resend_validation_email(
self,
*,
CertificateArn: str,
Domain: str,
ValidationDomain: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: ResendValidationEmailRequestRequestTypeDef = { # (1)
"CertificateArn": ...,
"Domain": ...,
"ValidationDomain": ...,
}
parent.resend_validation_email(**kwargs)
update_certificate_options
Updates a certificate.
Type annotations and code completion for session.client("acm").update_certificate_options
method.
boto3 documentation
await def update_certificate_options(
self,
*,
CertificateArn: str,
Options: CertificateOptionsTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateCertificateOptionsRequestRequestTypeDef = { # (1)
"CertificateArn": ...,
"Options": ...,
}
parent.update_certificate_options(**kwargs)
__aenter__
Type annotations and code completion for session.client("acm").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("acm").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("acm").get_paginator
method with overloads.
client.get_paginator("list_certificates")
-> ListCertificatesPaginator
get_waiter
Type annotations and code completion for session.client("acm").get_waiter
method with overloads.
client.get_waiter("certificate_validated")
-> CertificateValidatedWaiter