Skip to content

Type definitions#

Index > ACM > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: NotRequired[str],

CertificateOptionsTypeDef#

# CertificateOptionsTypeDef definition

class CertificateOptionsTypeDef(TypedDict):
    CertificateTransparencyLoggingPreference: NotRequired[CertificateTransparencyLoggingPreferenceType],  # (1)
  1. See CertificateTransparencyLoggingPreferenceType

ExtendedKeyUsageTypeDef#

# ExtendedKeyUsageTypeDef definition

class ExtendedKeyUsageTypeDef(TypedDict):
    Name: NotRequired[ExtendedKeyUsageNameType],  # (1)
    OID: NotRequired[str],
  1. See ExtendedKeyUsageNameType

KeyUsageTypeDef#

# KeyUsageTypeDef definition

class KeyUsageTypeDef(TypedDict):
    Name: NotRequired[KeyUsageNameType],  # (1)
  1. See KeyUsageNameType

CertificateSummaryTypeDef#

# CertificateSummaryTypeDef definition

class CertificateSummaryTypeDef(TypedDict):
    CertificateArn: NotRequired[str],
    DomainName: NotRequired[str],
    SubjectAlternativeNameSummaries: NotRequired[list[str]],
    HasAdditionalSubjectAlternativeNames: NotRequired[bool],
    Status: NotRequired[CertificateStatusType],  # (1)
    Type: NotRequired[CertificateTypeType],  # (2)
    KeyAlgorithm: NotRequired[KeyAlgorithmType],  # (3)
    KeyUsages: NotRequired[list[KeyUsageNameType]],  # (4)
    ExtendedKeyUsages: NotRequired[list[ExtendedKeyUsageNameType]],  # (5)
    InUse: NotRequired[bool],
    Exported: NotRequired[bool],
    RenewalEligibility: NotRequired[RenewalEligibilityType],  # (6)
    NotBefore: NotRequired[datetime],
    NotAfter: NotRequired[datetime],
    CreatedAt: NotRequired[datetime],
    IssuedAt: NotRequired[datetime],
    ImportedAt: NotRequired[datetime],
    RevokedAt: NotRequired[datetime],
  1. See CertificateStatusType
  2. See CertificateTypeType
  3. See KeyAlgorithmType
  4. See KeyUsageNameType
  5. See ExtendedKeyUsageNameType
  6. See RenewalEligibilityType

DeleteCertificateRequestRequestTypeDef#

# DeleteCertificateRequestRequestTypeDef definition

class DeleteCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,

DescribeCertificateRequestRequestTypeDef#

# DescribeCertificateRequestRequestTypeDef definition

class DescribeCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DomainValidationOptionTypeDef#

# DomainValidationOptionTypeDef definition

class DomainValidationOptionTypeDef(TypedDict):
    DomainName: str,
    ValidationDomain: str,

ResourceRecordTypeDef#

# ResourceRecordTypeDef definition

class ResourceRecordTypeDef(TypedDict):
    Name: str,
    Type: RecordTypeType,  # (1)
    Value: str,
  1. See RecordTypeType

ExpiryEventsConfigurationTypeDef#

# ExpiryEventsConfigurationTypeDef definition

class ExpiryEventsConfigurationTypeDef(TypedDict):
    DaysBeforeExpiry: NotRequired[int],

FiltersTypeDef#

# FiltersTypeDef definition

class FiltersTypeDef(TypedDict):
    extendedKeyUsage: NotRequired[Sequence[ExtendedKeyUsageNameType]],  # (1)
    keyUsage: NotRequired[Sequence[KeyUsageNameType]],  # (2)
    keyTypes: NotRequired[Sequence[KeyAlgorithmType]],  # (3)
  1. See ExtendedKeyUsageNameType
  2. See KeyUsageNameType
  3. See KeyAlgorithmType

GetCertificateRequestRequestTypeDef#

# GetCertificateRequestRequestTypeDef definition

class GetCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListTagsForCertificateRequestRequestTypeDef#

# ListTagsForCertificateRequestRequestTypeDef definition

class ListTagsForCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,

RenewCertificateRequestRequestTypeDef#

# RenewCertificateRequestRequestTypeDef definition

class RenewCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,

ResendValidationEmailRequestRequestTypeDef#

# ResendValidationEmailRequestRequestTypeDef definition

class ResendValidationEmailRequestRequestTypeDef(TypedDict):
    CertificateArn: str,
    Domain: str,
    ValidationDomain: str,

AddTagsToCertificateRequestRequestTypeDef#

# AddTagsToCertificateRequestRequestTypeDef definition

class AddTagsToCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

RemoveTagsFromCertificateRequestRequestTypeDef#

# RemoveTagsFromCertificateRequestRequestTypeDef definition

class RemoveTagsFromCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

ExportCertificateRequestRequestTypeDef#

# ExportCertificateRequestRequestTypeDef definition

class ExportCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,
    Passphrase: BlobTypeDef,

ImportCertificateRequestRequestTypeDef#

# ImportCertificateRequestRequestTypeDef definition

class ImportCertificateRequestRequestTypeDef(TypedDict):
    Certificate: BlobTypeDef,
    PrivateKey: BlobTypeDef,
    CertificateArn: NotRequired[str],
    CertificateChain: NotRequired[BlobTypeDef],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

UpdateCertificateOptionsRequestRequestTypeDef#

# UpdateCertificateOptionsRequestRequestTypeDef definition

class UpdateCertificateOptionsRequestRequestTypeDef(TypedDict):
    CertificateArn: str,
    Options: CertificateOptionsTypeDef,  # (1)
  1. See CertificateOptionsTypeDef

DescribeCertificateRequestWaitTypeDef#

# DescribeCertificateRequestWaitTypeDef definition

class DescribeCertificateRequestWaitTypeDef(TypedDict):
    CertificateArn: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExportCertificateResponseTypeDef#

# ExportCertificateResponseTypeDef definition

class ExportCertificateResponseTypeDef(TypedDict):
    Certificate: str,
    CertificateChain: str,
    PrivateKey: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetCertificateResponseTypeDef#

# GetCertificateResponseTypeDef definition

class GetCertificateResponseTypeDef(TypedDict):
    Certificate: str,
    CertificateChain: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ImportCertificateResponseTypeDef#

# ImportCertificateResponseTypeDef definition

class ImportCertificateResponseTypeDef(TypedDict):
    CertificateArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListCertificatesResponseTypeDef#

# ListCertificatesResponseTypeDef definition

class ListCertificatesResponseTypeDef(TypedDict):
    CertificateSummaryList: list[CertificateSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See CertificateSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForCertificateResponseTypeDef#

# ListTagsForCertificateResponseTypeDef definition

class ListTagsForCertificateResponseTypeDef(TypedDict):
    Tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

RequestCertificateResponseTypeDef#

# RequestCertificateResponseTypeDef definition

class RequestCertificateResponseTypeDef(TypedDict):
    CertificateArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RequestCertificateRequestRequestTypeDef#

# RequestCertificateRequestRequestTypeDef definition

class RequestCertificateRequestRequestTypeDef(TypedDict):
    DomainName: str,
    ValidationMethod: NotRequired[ValidationMethodType],  # (1)
    SubjectAlternativeNames: NotRequired[Sequence[str]],
    IdempotencyToken: NotRequired[str],
    DomainValidationOptions: NotRequired[Sequence[DomainValidationOptionTypeDef]],  # (2)
    Options: NotRequired[CertificateOptionsTypeDef],  # (3)
    CertificateAuthorityArn: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
    KeyAlgorithm: NotRequired[KeyAlgorithmType],  # (5)
  1. See ValidationMethodType
  2. See DomainValidationOptionTypeDef
  3. See CertificateOptionsTypeDef
  4. See TagTypeDef
  5. See KeyAlgorithmType

DomainValidationTypeDef#

# DomainValidationTypeDef definition

class DomainValidationTypeDef(TypedDict):
    DomainName: str,
    ValidationEmails: NotRequired[list[str]],
    ValidationDomain: NotRequired[str],
    ValidationStatus: NotRequired[DomainStatusType],  # (1)
    ResourceRecord: NotRequired[ResourceRecordTypeDef],  # (2)
    ValidationMethod: NotRequired[ValidationMethodType],  # (3)
  1. See DomainStatusType
  2. See ResourceRecordTypeDef
  3. See ValidationMethodType

GetAccountConfigurationResponseTypeDef#

# GetAccountConfigurationResponseTypeDef definition

class GetAccountConfigurationResponseTypeDef(TypedDict):
    ExpiryEvents: ExpiryEventsConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExpiryEventsConfigurationTypeDef
  2. See ResponseMetadataTypeDef

PutAccountConfigurationRequestRequestTypeDef#

# PutAccountConfigurationRequestRequestTypeDef definition

class PutAccountConfigurationRequestRequestTypeDef(TypedDict):
    IdempotencyToken: str,
    ExpiryEvents: NotRequired[ExpiryEventsConfigurationTypeDef],  # (1)
  1. See ExpiryEventsConfigurationTypeDef

ListCertificatesRequestRequestTypeDef#

# ListCertificatesRequestRequestTypeDef definition

class ListCertificatesRequestRequestTypeDef(TypedDict):
    CertificateStatuses: NotRequired[Sequence[CertificateStatusType]],  # (1)
    Includes: NotRequired[FiltersTypeDef],  # (2)
    NextToken: NotRequired[str],
    MaxItems: NotRequired[int],
    SortBy: NotRequired[SortByType],  # (3)
    SortOrder: NotRequired[SortOrderType],  # (4)
  1. See CertificateStatusType
  2. See FiltersTypeDef
  3. See SortByType
  4. See SortOrderType

ListCertificatesRequestPaginateTypeDef#

# ListCertificatesRequestPaginateTypeDef definition

class ListCertificatesRequestPaginateTypeDef(TypedDict):
    CertificateStatuses: NotRequired[Sequence[CertificateStatusType]],  # (1)
    Includes: NotRequired[FiltersTypeDef],  # (2)
    SortBy: NotRequired[SortByType],  # (3)
    SortOrder: NotRequired[SortOrderType],  # (4)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (5)
  1. See CertificateStatusType
  2. See FiltersTypeDef
  3. See SortByType
  4. See SortOrderType
  5. See PaginatorConfigTypeDef

RenewalSummaryTypeDef#

# RenewalSummaryTypeDef definition

class RenewalSummaryTypeDef(TypedDict):
    RenewalStatus: RenewalStatusType,  # (1)
    DomainValidationOptions: list[DomainValidationTypeDef],  # (2)
    UpdatedAt: datetime,
    RenewalStatusReason: NotRequired[FailureReasonType],  # (3)
  1. See RenewalStatusType
  2. See DomainValidationTypeDef
  3. See FailureReasonType

CertificateDetailTypeDef#

# CertificateDetailTypeDef definition

class CertificateDetailTypeDef(TypedDict):
    CertificateArn: NotRequired[str],
    DomainName: NotRequired[str],
    SubjectAlternativeNames: NotRequired[list[str]],
    DomainValidationOptions: NotRequired[list[DomainValidationTypeDef]],  # (1)
    Serial: NotRequired[str],
    Subject: NotRequired[str],
    Issuer: NotRequired[str],
    CreatedAt: NotRequired[datetime],
    IssuedAt: NotRequired[datetime],
    ImportedAt: NotRequired[datetime],
    Status: NotRequired[CertificateStatusType],  # (2)
    RevokedAt: NotRequired[datetime],
    RevocationReason: NotRequired[RevocationReasonType],  # (3)
    NotBefore: NotRequired[datetime],
    NotAfter: NotRequired[datetime],
    KeyAlgorithm: NotRequired[KeyAlgorithmType],  # (4)
    SignatureAlgorithm: NotRequired[str],
    InUseBy: NotRequired[list[str]],
    FailureReason: NotRequired[FailureReasonType],  # (5)
    Type: NotRequired[CertificateTypeType],  # (6)
    RenewalSummary: NotRequired[RenewalSummaryTypeDef],  # (7)
    KeyUsages: NotRequired[list[KeyUsageTypeDef]],  # (8)
    ExtendedKeyUsages: NotRequired[list[ExtendedKeyUsageTypeDef]],  # (9)
    CertificateAuthorityArn: NotRequired[str],
    RenewalEligibility: NotRequired[RenewalEligibilityType],  # (10)
    Options: NotRequired[CertificateOptionsTypeDef],  # (11)
  1. See DomainValidationTypeDef
  2. See CertificateStatusType
  3. See RevocationReasonType
  4. See KeyAlgorithmType
  5. See FailureReasonType
  6. See CertificateTypeType
  7. See RenewalSummaryTypeDef
  8. See KeyUsageTypeDef
  9. See ExtendedKeyUsageTypeDef
  10. See RenewalEligibilityType
  11. See CertificateOptionsTypeDef

DescribeCertificateResponseTypeDef#

# DescribeCertificateResponseTypeDef definition

class DescribeCertificateResponseTypeDef(TypedDict):
    Certificate: CertificateDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CertificateDetailTypeDef
  2. See ResponseMetadataTypeDef