Skip to content

Typed dictionaries

Index > ACM > Typed dictionaries

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

TagTypeDef

Usage Example
from mypy_boto3_acm.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: str,
    Value: NotRequired[str],

CertificateOptionsTypeDef

Usage Example
from mypy_boto3_acm.type_defs import CertificateOptionsTypeDef

def get_value() -> CertificateOptionsTypeDef:
    return {
        "CertificateTransparencyLoggingPreference": ...,
    }
Definition
class CertificateOptionsTypeDef(TypedDict):
    CertificateTransparencyLoggingPreference: NotRequired[CertificateTransparencyLoggingPreferenceType],  # (1)
  1. See CertificateTransparencyLoggingPreferenceType

ExtendedKeyUsageTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ExtendedKeyUsageTypeDef

def get_value() -> ExtendedKeyUsageTypeDef:
    return {
        "Name": ...,
    }
Definition
class ExtendedKeyUsageTypeDef(TypedDict):
    Name: NotRequired[ExtendedKeyUsageNameType],  # (1)
    OID: NotRequired[str],
  1. See ExtendedKeyUsageNameType

KeyUsageTypeDef

Usage Example
from mypy_boto3_acm.type_defs import KeyUsageTypeDef

def get_value() -> KeyUsageTypeDef:
    return {
        "Name": ...,
    }
Definition
class KeyUsageTypeDef(TypedDict):
    Name: NotRequired[KeyUsageNameType],  # (1)
  1. See KeyUsageNameType

CertificateSummaryTypeDef

Usage Example
from mypy_boto3_acm.type_defs import CertificateSummaryTypeDef

def get_value() -> CertificateSummaryTypeDef:
    return {
        "CertificateArn": ...,
    }
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

Usage Example
from mypy_boto3_acm.type_defs import DeleteCertificateRequestRequestTypeDef

def get_value() -> DeleteCertificateRequestRequestTypeDef:
    return {
        "CertificateArn": ...,
    }
Definition
class DeleteCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,

WaiterConfigTypeDef

Usage Example
from mypy_boto3_acm.type_defs import WaiterConfigTypeDef

def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }
Definition
class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeCertificateRequestRequestTypeDef

Usage Example
from mypy_boto3_acm.type_defs import DescribeCertificateRequestRequestTypeDef

def get_value() -> DescribeCertificateRequestRequestTypeDef:
    return {
        "CertificateArn": ...,
    }
Definition
class DescribeCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

DomainValidationOptionTypeDef

Usage Example
from mypy_boto3_acm.type_defs import DomainValidationOptionTypeDef

def get_value() -> DomainValidationOptionTypeDef:
    return {
        "DomainName": ...,
        "ValidationDomain": ...,
    }
Definition
class DomainValidationOptionTypeDef(TypedDict):
    DomainName: str,
    ValidationDomain: str,

ResourceRecordTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ResourceRecordTypeDef

def get_value() -> ResourceRecordTypeDef:
    return {
        "Name": ...,
        "Type": ...,
        "Value": ...,
    }
Definition
class ResourceRecordTypeDef(TypedDict):
    Name: str,
    Type: RecordTypeType,  # (1)
    Value: str,
  1. See RecordTypeType

ExpiryEventsConfigurationTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ExpiryEventsConfigurationTypeDef

def get_value() -> ExpiryEventsConfigurationTypeDef:
    return {
        "DaysBeforeExpiry": ...,
    }
Definition
class ExpiryEventsConfigurationTypeDef(TypedDict):
    DaysBeforeExpiry: NotRequired[int],

ExportCertificateRequestRequestTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ExportCertificateRequestRequestTypeDef

def get_value() -> ExportCertificateRequestRequestTypeDef:
    return {
        "CertificateArn": ...,
        "Passphrase": ...,
    }
Definition
class ExportCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,
    Passphrase: Union[str, bytes, IO[Any], StreamingBody],

FiltersTypeDef

Usage Example
from mypy_boto3_acm.type_defs import FiltersTypeDef

def get_value() -> FiltersTypeDef:
    return {
        "extendedKeyUsage": ...,
    }
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

Usage Example
from mypy_boto3_acm.type_defs import GetCertificateRequestRequestTypeDef

def get_value() -> GetCertificateRequestRequestTypeDef:
    return {
        "CertificateArn": ...,
    }
Definition
class GetCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_acm.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListTagsForCertificateRequestRequestTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ListTagsForCertificateRequestRequestTypeDef

def get_value() -> ListTagsForCertificateRequestRequestTypeDef:
    return {
        "CertificateArn": ...,
    }
Definition
class ListTagsForCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,

RenewCertificateRequestRequestTypeDef

Usage Example
from mypy_boto3_acm.type_defs import RenewCertificateRequestRequestTypeDef

def get_value() -> RenewCertificateRequestRequestTypeDef:
    return {
        "CertificateArn": ...,
    }
Definition
class RenewCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,

ResendValidationEmailRequestRequestTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ResendValidationEmailRequestRequestTypeDef

def get_value() -> ResendValidationEmailRequestRequestTypeDef:
    return {
        "CertificateArn": ...,
        "Domain": ...,
        "ValidationDomain": ...,
    }
Definition
class ResendValidationEmailRequestRequestTypeDef(TypedDict):
    CertificateArn: str,
    Domain: str,
    ValidationDomain: str,

AddTagsToCertificateRequestRequestTypeDef

Usage Example
from mypy_boto3_acm.type_defs import AddTagsToCertificateRequestRequestTypeDef

def get_value() -> AddTagsToCertificateRequestRequestTypeDef:
    return {
        "CertificateArn": ...,
        "Tags": ...,
    }
Definition
class AddTagsToCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

ImportCertificateRequestRequestTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ImportCertificateRequestRequestTypeDef

def get_value() -> ImportCertificateRequestRequestTypeDef:
    return {
        "Certificate": ...,
        "PrivateKey": ...,
    }
Definition
class ImportCertificateRequestRequestTypeDef(TypedDict):
    Certificate: Union[str, bytes, IO[Any], StreamingBody],
    PrivateKey: Union[str, bytes, IO[Any], StreamingBody],
    CertificateArn: NotRequired[str],
    CertificateChain: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

RemoveTagsFromCertificateRequestRequestTypeDef

Usage Example
from mypy_boto3_acm.type_defs import RemoveTagsFromCertificateRequestRequestTypeDef

def get_value() -> RemoveTagsFromCertificateRequestRequestTypeDef:
    return {
        "CertificateArn": ...,
        "Tags": ...,
    }
Definition
class RemoveTagsFromCertificateRequestRequestTypeDef(TypedDict):
    CertificateArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

UpdateCertificateOptionsRequestRequestTypeDef

Usage Example
from mypy_boto3_acm.type_defs import UpdateCertificateOptionsRequestRequestTypeDef

def get_value() -> UpdateCertificateOptionsRequestRequestTypeDef:
    return {
        "CertificateArn": ...,
        "Options": ...,
    }
Definition
class UpdateCertificateOptionsRequestRequestTypeDef(TypedDict):
    CertificateArn: str,
    Options: CertificateOptionsTypeDef,  # (1)
  1. See CertificateOptionsTypeDef

DescribeCertificateRequestCertificateValidatedWaitTypeDef

Usage Example
from mypy_boto3_acm.type_defs import DescribeCertificateRequestCertificateValidatedWaitTypeDef

def get_value() -> DescribeCertificateRequestCertificateValidatedWaitTypeDef:
    return {
        "CertificateArn": ...,
    }
Definition
class DescribeCertificateRequestCertificateValidatedWaitTypeDef(TypedDict):
    CertificateArn: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

EmptyResponseMetadataTypeDef

Usage Example
from mypy_boto3_acm.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExportCertificateResponseTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ExportCertificateResponseTypeDef

def get_value() -> ExportCertificateResponseTypeDef:
    return {
        "Certificate": ...,
        "CertificateChain": ...,
        "PrivateKey": ...,
        "ResponseMetadata": ...,
    }
Definition
class ExportCertificateResponseTypeDef(TypedDict):
    Certificate: str,
    CertificateChain: str,
    PrivateKey: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetCertificateResponseTypeDef

Usage Example
from mypy_boto3_acm.type_defs import GetCertificateResponseTypeDef

def get_value() -> GetCertificateResponseTypeDef:
    return {
        "Certificate": ...,
        "CertificateChain": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetCertificateResponseTypeDef(TypedDict):
    Certificate: str,
    CertificateChain: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ImportCertificateResponseTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ImportCertificateResponseTypeDef

def get_value() -> ImportCertificateResponseTypeDef:
    return {
        "CertificateArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class ImportCertificateResponseTypeDef(TypedDict):
    CertificateArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListCertificatesResponseTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ListCertificatesResponseTypeDef

def get_value() -> ListCertificatesResponseTypeDef:
    return {
        "NextToken": ...,
        "CertificateSummaryList": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListCertificatesResponseTypeDef(TypedDict):
    NextToken: str,
    CertificateSummaryList: List[CertificateSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CertificateSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForCertificateResponseTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ListTagsForCertificateResponseTypeDef

def get_value() -> ListTagsForCertificateResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForCertificateResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

RequestCertificateResponseTypeDef

Usage Example
from mypy_boto3_acm.type_defs import RequestCertificateResponseTypeDef

def get_value() -> RequestCertificateResponseTypeDef:
    return {
        "CertificateArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class RequestCertificateResponseTypeDef(TypedDict):
    CertificateArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RequestCertificateRequestRequestTypeDef

Usage Example
from mypy_boto3_acm.type_defs import RequestCertificateRequestRequestTypeDef

def get_value() -> RequestCertificateRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
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)
  1. See ValidationMethodType
  2. See DomainValidationOptionTypeDef
  3. See CertificateOptionsTypeDef
  4. See TagTypeDef

DomainValidationTypeDef

Usage Example
from mypy_boto3_acm.type_defs import DomainValidationTypeDef

def get_value() -> DomainValidationTypeDef:
    return {
        "DomainName": ...,
    }
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

Usage Example
from mypy_boto3_acm.type_defs import GetAccountConfigurationResponseTypeDef

def get_value() -> GetAccountConfigurationResponseTypeDef:
    return {
        "ExpiryEvents": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetAccountConfigurationResponseTypeDef(TypedDict):
    ExpiryEvents: ExpiryEventsConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExpiryEventsConfigurationTypeDef
  2. See ResponseMetadataTypeDef

PutAccountConfigurationRequestRequestTypeDef

Usage Example
from mypy_boto3_acm.type_defs import PutAccountConfigurationRequestRequestTypeDef

def get_value() -> PutAccountConfigurationRequestRequestTypeDef:
    return {
        "IdempotencyToken": ...,
    }
Definition
class PutAccountConfigurationRequestRequestTypeDef(TypedDict):
    IdempotencyToken: str,
    ExpiryEvents: NotRequired[ExpiryEventsConfigurationTypeDef],  # (1)
  1. See ExpiryEventsConfigurationTypeDef

ListCertificatesRequestRequestTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ListCertificatesRequestRequestTypeDef

def get_value() -> ListCertificatesRequestRequestTypeDef:
    return {
        "CertificateStatuses": ...,
    }
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

ListCertificatesRequestListCertificatesPaginateTypeDef

Usage Example
from mypy_boto3_acm.type_defs import ListCertificatesRequestListCertificatesPaginateTypeDef

def get_value() -> ListCertificatesRequestListCertificatesPaginateTypeDef:
    return {
        "CertificateStatuses": ...,
    }
Definition
class ListCertificatesRequestListCertificatesPaginateTypeDef(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

Usage Example
from mypy_boto3_acm.type_defs import RenewalSummaryTypeDef

def get_value() -> RenewalSummaryTypeDef:
    return {
        "RenewalStatus": ...,
        "DomainValidationOptions": ...,
        "UpdatedAt": ...,
    }
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

Usage Example
from mypy_boto3_acm.type_defs import CertificateDetailTypeDef

def get_value() -> CertificateDetailTypeDef:
    return {
        "CertificateArn": ...,
    }
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

Usage Example
from mypy_boto3_acm.type_defs import DescribeCertificateResponseTypeDef

def get_value() -> DescribeCertificateResponseTypeDef:
    return {
        "Certificate": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeCertificateResponseTypeDef(TypedDict):
    Certificate: CertificateDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CertificateDetailTypeDef
  2. See ResponseMetadataTypeDef