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.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 mypy_boto3_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 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)
...
# add_tags_to_certificate method usage example with argument unpacking
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 boto3.client("acm").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("acm").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
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)
...
# delete_certificate method usage example with argument unpacking
kwargs: DeleteCertificateRequestRequestTypeDef = { # (1)
"CertificateArn": ...,
}
parent.delete_certificate(**kwargs)
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)
...
# describe_certificate method usage example with argument unpacking
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 boto3.client("acm").export_certificate
method.
boto3 documentation
# export_certificate method definition
def export_certificate(
self,
*,
CertificateArn: str,
Passphrase: Union[str, bytes, IO[Any], StreamingBody],
) -> ExportCertificateResponseTypeDef: # (1)
...
# export_certificate method usage example with argument unpacking
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 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:
...
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)
...
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)
...
# get_certificate method usage example with argument unpacking
kwargs: GetCertificateRequestRequestTypeDef = { # (1)
"CertificateArn": ...,
}
parent.get_certificate(**kwargs)
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.