ACM¶
Installation¶
To install the ACM client:
Client¶
AsyncACMClient
¶
Bases: AsyncClient[AsyncACMConfig]
You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Certificate Manager User Guide.
Operations¶
add_tags_to_certificatecreate_acme_domain_validationcreate_acme_endpointcreate_acme_external_account_bindingdelete_acme_domain_validationdelete_acme_endpointdelete_acme_external_account_bindingdelete_certificatedescribe_acme_accountdescribe_acme_domain_validationdescribe_acme_endpointdescribe_acme_external_account_bindingdescribe_certificateexport_certificateget_account_configurationget_acme_external_account_binding_credentialsget_certificateimport_certificatelist_acme_accountslist_acme_domain_validationslist_acme_endpointslist_acme_external_account_bindingslist_certificate_domain_validationslist_certificateslist_tags_for_certificatelist_tags_for_resourceput_account_configurationremove_tags_from_certificaterenew_certificaterequest_certificateresend_validation_emailrevoke_acme_accountrevoke_acme_external_account_bindingrevoke_certificatesearch_certificatestag_resourceuntag_resourceupdate_acme_domain_validationupdate_acme_endpointupdate_certificate_options
Configuration¶
AsyncACMConfig
dataclass
¶
Bases: AsyncAwsConfig
ACM configuration (async-resolved).
Attributes¶
auth_scheme_resolver
class-attribute
instance-attribute
¶
An auth scheme resolver that determines the auth scheme for each operation.
auth_schemes
class-attribute
instance-attribute
¶
A map of auth scheme ids to auth schemes.
aws_access_key_id
class-attribute
instance-attribute
¶
aws_access_key_id: str | None = None
The identifier for a secret access key.
aws_credentials_identity_resolver
class-attribute
instance-attribute
¶
aws_credentials_identity_resolver: AsyncIdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None = None
Resolves AWS Credentials. Required for operations that use Sigv4 Auth.
aws_secret_access_key
class-attribute
instance-attribute
¶
aws_secret_access_key: str | None = None
A secret access key that can be used to sign requests.
aws_session_token
class-attribute
instance-attribute
¶
aws_session_token: str | None = None
The session token used with temporary AWS credentials.
endpoint_resolver
class-attribute
instance-attribute
¶
The endpoint resolver used to resolve the final endpoint per-operation based on the configuration.
interceptors
class-attribute
instance-attribute
¶
The list of interceptors, which are hooks that are called during the execution of a request.
protocol
class-attribute
instance-attribute
¶
Pass a protocol class reference from smithy_aws_core.aio.protocols to select the protocol, e.g. protocol=AsyncAwsJson10ClientProtocol. For custom protocols a protocol instance may also be passed.
region
class-attribute
instance-attribute
¶
region: str | None = None
The AWS region to connect to. The configured region is used to determine the service endpoint.
sdk_ua_app_id
class-attribute
instance-attribute
¶
sdk_ua_app_id: str | None = None
A unique and opaque application ID that is appended to the User-Agent header.
service_type
class-attribute
instance-attribute
¶
service_type: str | None = None
The service type: ACM or ACM-ACME. Injected via @staticContextParams.
use_dualstack_endpoint
class-attribute
instance-attribute
¶
use_dualstack_endpoint: bool | None = None
Use dual-stack endpoints.
use_fips_endpoint
class-attribute
instance-attribute
¶
use_fips_endpoint: bool | None = None
Use FIPS endpoints.
user_agent_extra
class-attribute
instance-attribute
¶
user_agent_extra: str | None = None
Additional suffix to be added to the User-Agent header.
Methods:¶
resolve
async
classmethod
¶
resolve(*, profile: str | None = None, fs: AsyncFileSystem | None = None, config_file_path: str | None = None, credentials_file_path: str | None = None, **overrides: Unpack[_AsyncACMConfigOverrides]) -> Self
Resolve config from environment, config files, defaults, and explicit overrides.
Plugin
module-attribute
¶
Plugin: TypeAlias = Callable[[AsyncACMConfig], None]
A callable that customizes a client configuration. Service-level plugins are applied once to the base configuration inherited by every operation. Operation-level plugins apply only to a single operation invocation.
Structures¶
AcmCertificateMetadataAcmeAccountAcmeAccountSummaryAcmeDomainValidationAcmeDomainValidationSummaryAcmeEndpointAcmeEndpointSummaryAcmeExternalAccountBindingAcmeExternalAccountBindingSummaryCertificateDetailCertificateOptionsCertificateSearchResultCertificateSummaryCommonNameFilterCustomAttributeDistinguishedNameDnsNameFilterDnsPrevalidationDetailsDnsPrevalidationOptionsDnsValidationChallengeDomainScopeDomainValidationDomainValidationMethodUpdateSummaryDomainValidationOptionDomainValidationSummaryEmailValidationChallengeExpirationExpiryEventsConfigurationExtendedKeyUsageFailureDetailsFiltersHttpRedirectKeyUsageOtherNamePublicCertificateAuthorityRenewalSummaryResourceRecordTagThrottlingReasonTimestampRangeUpdateSummaryValidationConfigurationX509Attributes
Errors¶
AccessDeniedExceptionConflictExceptionInternalServerExceptionInvalidArgsExceptionInvalidArnExceptionInvalidDomainValidationOptionsExceptionInvalidParameterExceptionInvalidStateExceptionInvalidTagExceptionLimitExceededExceptionRequestInProgressExceptionResourceInUseExceptionResourceNotFoundExceptionServiceErrorServiceQuotaExceededExceptionTagPolicyExceptionThrottlingExceptionTooManyTagsExceptionValidationException
Unions¶
AcmCertificateMetadataFilterCertificateAuthorityCertificateFilterCertificateFilterStatementCertificateMetadataGeneralNamePrevalidationDetailsPrevalidationOptionsSubjectAlternativeNameFilterSubjectFilterValidationChallengeX509AttributeFilter
Enums¶
AcmeAccountStatusAcmeAuthorizationBehaviorAcmeContactAcmeDomainValidationFailureReasonAcmeDomainValidationStatusAcmeEndpointStatusCertificateExportCertificateKeyPairOriginCertificateManagedByCertificateStatusCertificateTransparencyLoggingPreferenceCertificateTypeComparisonOperatorDomainScopeOptionDomainStatusExtendedKeyUsageNameFailureReasonKeyAlgorithmKeyUsageNamePrevalidationTypePublicKeyAlgorithmRecordTypeRenewalEligibilityRenewalStatusRevocationReasonSearchCertificatesSortBySearchCertificatesSortOrderSortBySortOrderTimeTypeUpdateStatusUpdateTypeValidationMethod