Type definitions#
Auto-generated documentation for ACM type annotations stubs module types-boto3-acm.
BlobTypeDef#
# BlobTypeDef Union usage example
from types_boto3_acm.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
TagTypeDef#
# TagTypeDef TypedDict usage example
from types_boto3_acm.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: NotRequired[str],
CertificateOptionsTypeDef#
# CertificateOptionsTypeDef TypedDict usage example
from types_boto3_acm.type_defs import CertificateOptionsTypeDef
def get_value() -> CertificateOptionsTypeDef:
return {
"CertificateTransparencyLoggingPreference": ...,
}
# CertificateOptionsTypeDef definition
class CertificateOptionsTypeDef(TypedDict):
CertificateTransparencyLoggingPreference: NotRequired[CertificateTransparencyLoggingPreferenceType], # (1)
ExtendedKeyUsageTypeDef#
# ExtendedKeyUsageTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ExtendedKeyUsageTypeDef
def get_value() -> ExtendedKeyUsageTypeDef:
return {
"Name": ...,
}
# ExtendedKeyUsageTypeDef definition
class ExtendedKeyUsageTypeDef(TypedDict):
Name: NotRequired[ExtendedKeyUsageNameType], # (1)
OID: NotRequired[str],
KeyUsageTypeDef#
# KeyUsageTypeDef TypedDict usage example
from types_boto3_acm.type_defs import KeyUsageTypeDef
def get_value() -> KeyUsageTypeDef:
return {
"Name": ...,
}
# KeyUsageTypeDef definition
class KeyUsageTypeDef(TypedDict):
Name: NotRequired[KeyUsageNameType], # (1)
- See KeyUsageNameType
CertificateSummaryTypeDef#
# CertificateSummaryTypeDef TypedDict usage example
from types_boto3_acm.type_defs import CertificateSummaryTypeDef
def get_value() -> CertificateSummaryTypeDef:
return {
"CertificateArn": ...,
}
# 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],
- See CertificateStatusType
- See CertificateTypeType
- See KeyAlgorithmType
- See KeyUsageNameType
- See ExtendedKeyUsageNameType
- See RenewalEligibilityType
DeleteCertificateRequestTypeDef#
# DeleteCertificateRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import DeleteCertificateRequestTypeDef
def get_value() -> DeleteCertificateRequestTypeDef:
return {
"CertificateArn": ...,
}
# DeleteCertificateRequestTypeDef definition
class DeleteCertificateRequestTypeDef(TypedDict):
CertificateArn: str,
DescribeCertificateRequestTypeDef#
# DescribeCertificateRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import DescribeCertificateRequestTypeDef
def get_value() -> DescribeCertificateRequestTypeDef:
return {
"CertificateArn": ...,
}
# DescribeCertificateRequestTypeDef definition
class DescribeCertificateRequestTypeDef(TypedDict):
CertificateArn: str,
WaiterConfigTypeDef#
# WaiterConfigTypeDef TypedDict usage example
from types_boto3_acm.type_defs import WaiterConfigTypeDef
def get_value() -> WaiterConfigTypeDef:
return {
"Delay": ...,
}
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
DomainValidationOptionTypeDef#
# DomainValidationOptionTypeDef TypedDict usage example
from types_boto3_acm.type_defs import DomainValidationOptionTypeDef
def get_value() -> DomainValidationOptionTypeDef:
return {
"DomainName": ...,
}
# DomainValidationOptionTypeDef definition
class DomainValidationOptionTypeDef(TypedDict):
DomainName: str,
ValidationDomain: str,
ResourceRecordTypeDef#
# ResourceRecordTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ResourceRecordTypeDef
def get_value() -> ResourceRecordTypeDef:
return {
"Name": ...,
}
# ResourceRecordTypeDef definition
class ResourceRecordTypeDef(TypedDict):
Name: str,
Type: RecordTypeType, # (1)
Value: str,
- See RecordTypeType
ExpiryEventsConfigurationTypeDef#
# ExpiryEventsConfigurationTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ExpiryEventsConfigurationTypeDef
def get_value() -> ExpiryEventsConfigurationTypeDef:
return {
"DaysBeforeExpiry": ...,
}
# ExpiryEventsConfigurationTypeDef definition
class ExpiryEventsConfigurationTypeDef(TypedDict):
DaysBeforeExpiry: NotRequired[int],
FiltersTypeDef#
# FiltersTypeDef TypedDict usage example
from types_boto3_acm.type_defs import FiltersTypeDef
def get_value() -> FiltersTypeDef:
return {
"extendedKeyUsage": ...,
}
# FiltersTypeDef definition
class FiltersTypeDef(TypedDict):
extendedKeyUsage: NotRequired[Sequence[ExtendedKeyUsageNameType]], # (1)
keyUsage: NotRequired[Sequence[KeyUsageNameType]], # (2)
keyTypes: NotRequired[Sequence[KeyAlgorithmType]], # (3)
- See ExtendedKeyUsageNameType
- See KeyUsageNameType
- See KeyAlgorithmType
GetCertificateRequestTypeDef#
# GetCertificateRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import GetCertificateRequestTypeDef
def get_value() -> GetCertificateRequestTypeDef:
return {
"CertificateArn": ...,
}
# GetCertificateRequestTypeDef definition
class GetCertificateRequestTypeDef(TypedDict):
CertificateArn: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from types_boto3_acm.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListTagsForCertificateRequestTypeDef#
# ListTagsForCertificateRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ListTagsForCertificateRequestTypeDef
def get_value() -> ListTagsForCertificateRequestTypeDef:
return {
"CertificateArn": ...,
}
# ListTagsForCertificateRequestTypeDef definition
class ListTagsForCertificateRequestTypeDef(TypedDict):
CertificateArn: str,
RenewCertificateRequestTypeDef#
# RenewCertificateRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import RenewCertificateRequestTypeDef
def get_value() -> RenewCertificateRequestTypeDef:
return {
"CertificateArn": ...,
}
# RenewCertificateRequestTypeDef definition
class RenewCertificateRequestTypeDef(TypedDict):
CertificateArn: str,
ResendValidationEmailRequestTypeDef#
# ResendValidationEmailRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ResendValidationEmailRequestTypeDef
def get_value() -> ResendValidationEmailRequestTypeDef:
return {
"CertificateArn": ...,
}
# ResendValidationEmailRequestTypeDef definition
class ResendValidationEmailRequestTypeDef(TypedDict):
CertificateArn: str,
Domain: str,
ValidationDomain: str,
AddTagsToCertificateRequestTypeDef#
# AddTagsToCertificateRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import AddTagsToCertificateRequestTypeDef
def get_value() -> AddTagsToCertificateRequestTypeDef:
return {
"CertificateArn": ...,
}
# AddTagsToCertificateRequestTypeDef definition
class AddTagsToCertificateRequestTypeDef(TypedDict):
CertificateArn: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
RemoveTagsFromCertificateRequestTypeDef#
# RemoveTagsFromCertificateRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import RemoveTagsFromCertificateRequestTypeDef
def get_value() -> RemoveTagsFromCertificateRequestTypeDef:
return {
"CertificateArn": ...,
}
# RemoveTagsFromCertificateRequestTypeDef definition
class RemoveTagsFromCertificateRequestTypeDef(TypedDict):
CertificateArn: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
ExportCertificateRequestTypeDef#
# ExportCertificateRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ExportCertificateRequestTypeDef
def get_value() -> ExportCertificateRequestTypeDef:
return {
"CertificateArn": ...,
}
# ExportCertificateRequestTypeDef definition
class ExportCertificateRequestTypeDef(TypedDict):
CertificateArn: str,
Passphrase: BlobTypeDef,
ImportCertificateRequestTypeDef#
# ImportCertificateRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ImportCertificateRequestTypeDef
def get_value() -> ImportCertificateRequestTypeDef:
return {
"Certificate": ...,
}
# ImportCertificateRequestTypeDef definition
class ImportCertificateRequestTypeDef(TypedDict):
Certificate: BlobTypeDef,
PrivateKey: BlobTypeDef,
CertificateArn: NotRequired[str],
CertificateChain: NotRequired[BlobTypeDef],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
UpdateCertificateOptionsRequestTypeDef#
# UpdateCertificateOptionsRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import UpdateCertificateOptionsRequestTypeDef
def get_value() -> UpdateCertificateOptionsRequestTypeDef:
return {
"CertificateArn": ...,
}
# UpdateCertificateOptionsRequestTypeDef definition
class UpdateCertificateOptionsRequestTypeDef(TypedDict):
CertificateArn: str,
Options: CertificateOptionsTypeDef, # (1)
DescribeCertificateRequestWaitTypeDef#
# DescribeCertificateRequestWaitTypeDef TypedDict usage example
from types_boto3_acm.type_defs import DescribeCertificateRequestWaitTypeDef
def get_value() -> DescribeCertificateRequestWaitTypeDef:
return {
"CertificateArn": ...,
}
# DescribeCertificateRequestWaitTypeDef definition
class DescribeCertificateRequestWaitTypeDef(TypedDict):
CertificateArn: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef TypedDict usage example
from types_boto3_acm.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ExportCertificateResponseTypeDef#
# ExportCertificateResponseTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ExportCertificateResponseTypeDef
def get_value() -> ExportCertificateResponseTypeDef:
return {
"Certificate": ...,
}
# ExportCertificateResponseTypeDef definition
class ExportCertificateResponseTypeDef(TypedDict):
Certificate: str,
CertificateChain: str,
PrivateKey: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetCertificateResponseTypeDef#
# GetCertificateResponseTypeDef TypedDict usage example
from types_boto3_acm.type_defs import GetCertificateResponseTypeDef
def get_value() -> GetCertificateResponseTypeDef:
return {
"Certificate": ...,
}
# GetCertificateResponseTypeDef definition
class GetCertificateResponseTypeDef(TypedDict):
Certificate: str,
CertificateChain: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ImportCertificateResponseTypeDef#
# ImportCertificateResponseTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ImportCertificateResponseTypeDef
def get_value() -> ImportCertificateResponseTypeDef:
return {
"CertificateArn": ...,
}
# ImportCertificateResponseTypeDef definition
class ImportCertificateResponseTypeDef(TypedDict):
CertificateArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListCertificatesResponseTypeDef#
# ListCertificatesResponseTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ListCertificatesResponseTypeDef
def get_value() -> ListCertificatesResponseTypeDef:
return {
"NextToken": ...,
}
# ListCertificatesResponseTypeDef definition
class ListCertificatesResponseTypeDef(TypedDict):
CertificateSummaryList: List[CertificateSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListTagsForCertificateResponseTypeDef#
# ListTagsForCertificateResponseTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ListTagsForCertificateResponseTypeDef
def get_value() -> ListTagsForCertificateResponseTypeDef:
return {
"Tags": ...,
}
# ListTagsForCertificateResponseTypeDef definition
class ListTagsForCertificateResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
RequestCertificateResponseTypeDef#
# RequestCertificateResponseTypeDef TypedDict usage example
from types_boto3_acm.type_defs import RequestCertificateResponseTypeDef
def get_value() -> RequestCertificateResponseTypeDef:
return {
"CertificateArn": ...,
}
# RequestCertificateResponseTypeDef definition
class RequestCertificateResponseTypeDef(TypedDict):
CertificateArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RequestCertificateRequestTypeDef#
# RequestCertificateRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import RequestCertificateRequestTypeDef
def get_value() -> RequestCertificateRequestTypeDef:
return {
"DomainName": ...,
}
# RequestCertificateRequestTypeDef definition
class RequestCertificateRequestTypeDef(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)
- See ValidationMethodType
- See DomainValidationOptionTypeDef
- See CertificateOptionsTypeDef
- See TagTypeDef
- See KeyAlgorithmType
DomainValidationTypeDef#
# DomainValidationTypeDef TypedDict usage example
from types_boto3_acm.type_defs import DomainValidationTypeDef
def get_value() -> DomainValidationTypeDef:
return {
"DomainName": ...,
}
# 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)
GetAccountConfigurationResponseTypeDef#
# GetAccountConfigurationResponseTypeDef TypedDict usage example
from types_boto3_acm.type_defs import GetAccountConfigurationResponseTypeDef
def get_value() -> GetAccountConfigurationResponseTypeDef:
return {
"ExpiryEvents": ...,
}
# GetAccountConfigurationResponseTypeDef definition
class GetAccountConfigurationResponseTypeDef(TypedDict):
ExpiryEvents: ExpiryEventsConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutAccountConfigurationRequestTypeDef#
# PutAccountConfigurationRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import PutAccountConfigurationRequestTypeDef
def get_value() -> PutAccountConfigurationRequestTypeDef:
return {
"IdempotencyToken": ...,
}
# PutAccountConfigurationRequestTypeDef definition
class PutAccountConfigurationRequestTypeDef(TypedDict):
IdempotencyToken: str,
ExpiryEvents: NotRequired[ExpiryEventsConfigurationTypeDef], # (1)
ListCertificatesRequestTypeDef#
# ListCertificatesRequestTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ListCertificatesRequestTypeDef
def get_value() -> ListCertificatesRequestTypeDef:
return {
"CertificateStatuses": ...,
}
# ListCertificatesRequestTypeDef definition
class ListCertificatesRequestTypeDef(TypedDict):
CertificateStatuses: NotRequired[Sequence[CertificateStatusType]], # (1)
Includes: NotRequired[FiltersTypeDef], # (2)
NextToken: NotRequired[str],
MaxItems: NotRequired[int],
SortBy: NotRequired[SortByType], # (3)
SortOrder: NotRequired[SortOrderType], # (4)
- See CertificateStatusType
- See FiltersTypeDef
- See SortByType
- See SortOrderType
ListCertificatesRequestPaginateTypeDef#
# ListCertificatesRequestPaginateTypeDef TypedDict usage example
from types_boto3_acm.type_defs import ListCertificatesRequestPaginateTypeDef
def get_value() -> ListCertificatesRequestPaginateTypeDef:
return {
"CertificateStatuses": ...,
}
# 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)
- See CertificateStatusType
- See FiltersTypeDef
- See SortByType
- See SortOrderType
- See PaginatorConfigTypeDef
RenewalSummaryTypeDef#
# RenewalSummaryTypeDef TypedDict usage example
from types_boto3_acm.type_defs import RenewalSummaryTypeDef
def get_value() -> RenewalSummaryTypeDef:
return {
"RenewalStatus": ...,
}
# RenewalSummaryTypeDef definition
class RenewalSummaryTypeDef(TypedDict):
RenewalStatus: RenewalStatusType, # (1)
DomainValidationOptions: List[DomainValidationTypeDef], # (2)
UpdatedAt: datetime,
RenewalStatusReason: NotRequired[FailureReasonType], # (3)
CertificateDetailTypeDef#
# CertificateDetailTypeDef TypedDict usage example
from types_boto3_acm.type_defs import CertificateDetailTypeDef
def get_value() -> CertificateDetailTypeDef:
return {
"CertificateArn": ...,
}
# 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)
- See DomainValidationTypeDef
- See CertificateStatusType
- See RevocationReasonType
- See KeyAlgorithmType
- See FailureReasonType
- See CertificateTypeType
- See RenewalSummaryTypeDef
- See KeyUsageTypeDef
- See ExtendedKeyUsageTypeDef
- See RenewalEligibilityType
- See CertificateOptionsTypeDef
DescribeCertificateResponseTypeDef#
# DescribeCertificateResponseTypeDef TypedDict usage example
from types_boto3_acm.type_defs import DescribeCertificateResponseTypeDef
def get_value() -> DescribeCertificateResponseTypeDef:
return {
"Certificate": ...,
}
# DescribeCertificateResponseTypeDef definition
class DescribeCertificateResponseTypeDef(TypedDict):
Certificate: CertificateDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)