Typed dictionaries
Auto-generated documentation for Support type annotations stubs module mypy-boto3-support.
AttachmentTypeDef
Usage Example
from mypy_boto3_support.type_defs import AttachmentTypeDef
def get_value() -> AttachmentTypeDef:
return {
"fileName": ...,
}
Definition
class AttachmentTypeDef(TypedDict):
fileName: NotRequired[str],
data: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_support.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,
AddCommunicationToCaseRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import AddCommunicationToCaseRequestRequestTypeDef
def get_value() -> AddCommunicationToCaseRequestRequestTypeDef:
return {
"communicationBody": ...,
}
Definition
class AddCommunicationToCaseRequestRequestTypeDef(TypedDict):
communicationBody: str,
caseId: NotRequired[str],
ccEmailAddresses: NotRequired[Sequence[str]],
attachmentSetId: NotRequired[str],
AttachmentDetailsTypeDef
Usage Example
from mypy_boto3_support.type_defs import AttachmentDetailsTypeDef
def get_value() -> AttachmentDetailsTypeDef:
return {
"attachmentId": ...,
}
Definition
class AttachmentDetailsTypeDef(TypedDict):
attachmentId: NotRequired[str],
fileName: NotRequired[str],
CategoryTypeDef
Usage Example
from mypy_boto3_support.type_defs import CategoryTypeDef
def get_value() -> CategoryTypeDef:
return {
"code": ...,
}
CreateCaseRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import CreateCaseRequestRequestTypeDef
def get_value() -> CreateCaseRequestRequestTypeDef:
return {
"subject": ...,
"communicationBody": ...,
}
Definition
class CreateCaseRequestRequestTypeDef(TypedDict):
subject: str,
communicationBody: str,
serviceCode: NotRequired[str],
severityCode: NotRequired[str],
categoryCode: NotRequired[str],
ccEmailAddresses: NotRequired[Sequence[str]],
language: NotRequired[str],
issueType: NotRequired[str],
attachmentSetId: NotRequired[str],
DescribeAttachmentRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeAttachmentRequestRequestTypeDef
def get_value() -> DescribeAttachmentRequestRequestTypeDef:
return {
"attachmentId": ...,
}
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_support.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeCasesRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeCasesRequestRequestTypeDef
def get_value() -> DescribeCasesRequestRequestTypeDef:
return {
"caseIdList": ...,
}
Definition
class DescribeCasesRequestRequestTypeDef(TypedDict):
caseIdList: NotRequired[Sequence[str]],
displayId: NotRequired[str],
afterTime: NotRequired[str],
beforeTime: NotRequired[str],
includeResolvedCases: NotRequired[bool],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
language: NotRequired[str],
includeCommunications: NotRequired[bool],
DescribeCommunicationsRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeCommunicationsRequestRequestTypeDef
def get_value() -> DescribeCommunicationsRequestRequestTypeDef:
return {
"caseId": ...,
}
Definition
class DescribeCommunicationsRequestRequestTypeDef(TypedDict):
caseId: str,
beforeTime: NotRequired[str],
afterTime: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
DescribeServicesRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeServicesRequestRequestTypeDef
def get_value() -> DescribeServicesRequestRequestTypeDef:
return {
"serviceCodeList": ...,
}
Definition
class DescribeServicesRequestRequestTypeDef(TypedDict):
serviceCodeList: NotRequired[Sequence[str]],
language: NotRequired[str],
DescribeSeverityLevelsRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeSeverityLevelsRequestRequestTypeDef
def get_value() -> DescribeSeverityLevelsRequestRequestTypeDef:
return {
"language": ...,
}
SeverityLevelTypeDef
Usage Example
from mypy_boto3_support.type_defs import SeverityLevelTypeDef
def get_value() -> SeverityLevelTypeDef:
return {
"code": ...,
}
DescribeTrustedAdvisorCheckRefreshStatusesRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeTrustedAdvisorCheckRefreshStatusesRequestRequestTypeDef
def get_value() -> DescribeTrustedAdvisorCheckRefreshStatusesRequestRequestTypeDef:
return {
"checkIds": ...,
}
Definition
class DescribeTrustedAdvisorCheckRefreshStatusesRequestRequestTypeDef(TypedDict):
checkIds: Sequence[str],
TrustedAdvisorCheckRefreshStatusTypeDef
Usage Example
from mypy_boto3_support.type_defs import TrustedAdvisorCheckRefreshStatusTypeDef
def get_value() -> TrustedAdvisorCheckRefreshStatusTypeDef:
return {
"checkId": ...,
"status": ...,
"millisUntilNextRefreshable": ...,
}
Definition
class TrustedAdvisorCheckRefreshStatusTypeDef(TypedDict):
checkId: str,
status: str,
millisUntilNextRefreshable: int,
DescribeTrustedAdvisorCheckResultRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeTrustedAdvisorCheckResultRequestRequestTypeDef
def get_value() -> DescribeTrustedAdvisorCheckResultRequestRequestTypeDef:
return {
"checkId": ...,
}
Definition
class DescribeTrustedAdvisorCheckResultRequestRequestTypeDef(TypedDict):
checkId: str,
language: NotRequired[str],
DescribeTrustedAdvisorCheckSummariesRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeTrustedAdvisorCheckSummariesRequestRequestTypeDef
def get_value() -> DescribeTrustedAdvisorCheckSummariesRequestRequestTypeDef:
return {
"checkIds": ...,
}
Definition
class DescribeTrustedAdvisorCheckSummariesRequestRequestTypeDef(TypedDict):
checkIds: Sequence[str],
DescribeTrustedAdvisorChecksRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeTrustedAdvisorChecksRequestRequestTypeDef
def get_value() -> DescribeTrustedAdvisorChecksRequestRequestTypeDef:
return {
"language": ...,
}
TrustedAdvisorCheckDescriptionTypeDef
Usage Example
from mypy_boto3_support.type_defs import TrustedAdvisorCheckDescriptionTypeDef
def get_value() -> TrustedAdvisorCheckDescriptionTypeDef:
return {
"id": ...,
"name": ...,
"description": ...,
"category": ...,
"metadata": ...,
}
Definition
class TrustedAdvisorCheckDescriptionTypeDef(TypedDict):
id: str,
name: str,
description: str,
category: str,
metadata: List[str],
RefreshTrustedAdvisorCheckRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import RefreshTrustedAdvisorCheckRequestRequestTypeDef
def get_value() -> RefreshTrustedAdvisorCheckRequestRequestTypeDef:
return {
"checkId": ...,
}
ResolveCaseRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import ResolveCaseRequestRequestTypeDef
def get_value() -> ResolveCaseRequestRequestTypeDef:
return {
"caseId": ...,
}
TrustedAdvisorCostOptimizingSummaryTypeDef
Usage Example
from mypy_boto3_support.type_defs import TrustedAdvisorCostOptimizingSummaryTypeDef
def get_value() -> TrustedAdvisorCostOptimizingSummaryTypeDef:
return {
"estimatedMonthlySavings": ...,
"estimatedPercentMonthlySavings": ...,
}
Definition
class TrustedAdvisorCostOptimizingSummaryTypeDef(TypedDict):
estimatedMonthlySavings: float,
estimatedPercentMonthlySavings: float,
TrustedAdvisorResourceDetailTypeDef
Usage Example
from mypy_boto3_support.type_defs import TrustedAdvisorResourceDetailTypeDef
def get_value() -> TrustedAdvisorResourceDetailTypeDef:
return {
"status": ...,
"resourceId": ...,
"metadata": ...,
}
Definition
class TrustedAdvisorResourceDetailTypeDef(TypedDict):
status: str,
resourceId: str,
metadata: List[str],
region: NotRequired[str],
isSuppressed: NotRequired[bool],
TrustedAdvisorResourcesSummaryTypeDef
Usage Example
from mypy_boto3_support.type_defs import TrustedAdvisorResourcesSummaryTypeDef
def get_value() -> TrustedAdvisorResourcesSummaryTypeDef:
return {
"resourcesProcessed": ...,
"resourcesFlagged": ...,
"resourcesIgnored": ...,
"resourcesSuppressed": ...,
}
Definition
class TrustedAdvisorResourcesSummaryTypeDef(TypedDict):
resourcesProcessed: int,
resourcesFlagged: int,
resourcesIgnored: int,
resourcesSuppressed: int,
AddAttachmentsToSetRequestRequestTypeDef
Usage Example
from mypy_boto3_support.type_defs import AddAttachmentsToSetRequestRequestTypeDef
def get_value() -> AddAttachmentsToSetRequestRequestTypeDef:
return {
"attachments": ...,
}
Definition
class AddAttachmentsToSetRequestRequestTypeDef(TypedDict):
attachments: Sequence[AttachmentTypeDef], # (1)
attachmentSetId: NotRequired[str],
AddAttachmentsToSetResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import AddAttachmentsToSetResponseTypeDef
def get_value() -> AddAttachmentsToSetResponseTypeDef:
return {
"attachmentSetId": ...,
"expiryTime": ...,
"ResponseMetadata": ...,
}
Definition
class AddAttachmentsToSetResponseTypeDef(TypedDict):
attachmentSetId: str,
expiryTime: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AddCommunicationToCaseResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import AddCommunicationToCaseResponseTypeDef
def get_value() -> AddCommunicationToCaseResponseTypeDef:
return {
"result": ...,
"ResponseMetadata": ...,
}
Definition
class AddCommunicationToCaseResponseTypeDef(TypedDict):
result: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateCaseResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import CreateCaseResponseTypeDef
def get_value() -> CreateCaseResponseTypeDef:
return {
"caseId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateCaseResponseTypeDef(TypedDict):
caseId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeAttachmentResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeAttachmentResponseTypeDef
def get_value() -> DescribeAttachmentResponseTypeDef:
return {
"attachment": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeAttachmentResponseTypeDef(TypedDict):
attachment: AttachmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ResolveCaseResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import ResolveCaseResponseTypeDef
def get_value() -> ResolveCaseResponseTypeDef:
return {
"initialCaseStatus": ...,
"finalCaseStatus": ...,
"ResponseMetadata": ...,
}
Definition
class ResolveCaseResponseTypeDef(TypedDict):
initialCaseStatus: str,
finalCaseStatus: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CommunicationTypeDef
Usage Example
from mypy_boto3_support.type_defs import CommunicationTypeDef
def get_value() -> CommunicationTypeDef:
return {
"caseId": ...,
}
Definition
class CommunicationTypeDef(TypedDict):
caseId: NotRequired[str],
body: NotRequired[str],
submittedBy: NotRequired[str],
timeCreated: NotRequired[str],
attachmentSet: NotRequired[List[AttachmentDetailsTypeDef]], # (1)
ServiceTypeDef
Usage Example
from mypy_boto3_support.type_defs import ServiceTypeDef
def get_value() -> ServiceTypeDef:
return {
"code": ...,
}
Definition
class ServiceTypeDef(TypedDict):
code: NotRequired[str],
name: NotRequired[str],
categories: NotRequired[List[CategoryTypeDef]], # (1)
- See CategoryTypeDef
DescribeCasesRequestDescribeCasesPaginateTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeCasesRequestDescribeCasesPaginateTypeDef
def get_value() -> DescribeCasesRequestDescribeCasesPaginateTypeDef:
return {
"caseIdList": ...,
}
Definition
class DescribeCasesRequestDescribeCasesPaginateTypeDef(TypedDict):
caseIdList: NotRequired[Sequence[str]],
displayId: NotRequired[str],
afterTime: NotRequired[str],
beforeTime: NotRequired[str],
includeResolvedCases: NotRequired[bool],
language: NotRequired[str],
includeCommunications: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeCommunicationsRequestDescribeCommunicationsPaginateTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeCommunicationsRequestDescribeCommunicationsPaginateTypeDef
def get_value() -> DescribeCommunicationsRequestDescribeCommunicationsPaginateTypeDef:
return {
"caseId": ...,
}
Definition
class DescribeCommunicationsRequestDescribeCommunicationsPaginateTypeDef(TypedDict):
caseId: str,
beforeTime: NotRequired[str],
afterTime: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeSeverityLevelsResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeSeverityLevelsResponseTypeDef
def get_value() -> DescribeSeverityLevelsResponseTypeDef:
return {
"severityLevels": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeSeverityLevelsResponseTypeDef(TypedDict):
severityLevels: List[SeverityLevelTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeTrustedAdvisorCheckRefreshStatusesResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeTrustedAdvisorCheckRefreshStatusesResponseTypeDef
def get_value() -> DescribeTrustedAdvisorCheckRefreshStatusesResponseTypeDef:
return {
"statuses": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeTrustedAdvisorCheckRefreshStatusesResponseTypeDef(TypedDict):
statuses: List[TrustedAdvisorCheckRefreshStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RefreshTrustedAdvisorCheckResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import RefreshTrustedAdvisorCheckResponseTypeDef
def get_value() -> RefreshTrustedAdvisorCheckResponseTypeDef:
return {
"status": ...,
"ResponseMetadata": ...,
}
Definition
class RefreshTrustedAdvisorCheckResponseTypeDef(TypedDict):
status: TrustedAdvisorCheckRefreshStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeTrustedAdvisorChecksResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeTrustedAdvisorChecksResponseTypeDef
def get_value() -> DescribeTrustedAdvisorChecksResponseTypeDef:
return {
"checks": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeTrustedAdvisorChecksResponseTypeDef(TypedDict):
checks: List[TrustedAdvisorCheckDescriptionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TrustedAdvisorCategorySpecificSummaryTypeDef
Usage Example
from mypy_boto3_support.type_defs import TrustedAdvisorCategorySpecificSummaryTypeDef
def get_value() -> TrustedAdvisorCategorySpecificSummaryTypeDef:
return {
"costOptimizing": ...,
}
Definition
class TrustedAdvisorCategorySpecificSummaryTypeDef(TypedDict):
costOptimizing: NotRequired[TrustedAdvisorCostOptimizingSummaryTypeDef], # (1)
DescribeCommunicationsResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeCommunicationsResponseTypeDef
def get_value() -> DescribeCommunicationsResponseTypeDef:
return {
"communications": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeCommunicationsResponseTypeDef(TypedDict):
communications: List[CommunicationTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RecentCaseCommunicationsTypeDef
Usage Example
from mypy_boto3_support.type_defs import RecentCaseCommunicationsTypeDef
def get_value() -> RecentCaseCommunicationsTypeDef:
return {
"communications": ...,
}
Definition
class RecentCaseCommunicationsTypeDef(TypedDict):
communications: NotRequired[List[CommunicationTypeDef]], # (1)
nextToken: NotRequired[str],
DescribeServicesResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeServicesResponseTypeDef
def get_value() -> DescribeServicesResponseTypeDef:
return {
"services": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeServicesResponseTypeDef(TypedDict):
services: List[ServiceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TrustedAdvisorCheckResultTypeDef
Usage Example
from mypy_boto3_support.type_defs import TrustedAdvisorCheckResultTypeDef
def get_value() -> TrustedAdvisorCheckResultTypeDef:
return {
"checkId": ...,
"timestamp": ...,
"status": ...,
"resourcesSummary": ...,
"categorySpecificSummary": ...,
"flaggedResources": ...,
}
Definition
class TrustedAdvisorCheckResultTypeDef(TypedDict):
checkId: str,
timestamp: str,
status: str,
resourcesSummary: TrustedAdvisorResourcesSummaryTypeDef, # (1)
categorySpecificSummary: TrustedAdvisorCategorySpecificSummaryTypeDef, # (2)
flaggedResources: List[TrustedAdvisorResourceDetailTypeDef], # (3)
- See TrustedAdvisorResourcesSummaryTypeDef
- See TrustedAdvisorCategorySpecificSummaryTypeDef
- See TrustedAdvisorResourceDetailTypeDef
TrustedAdvisorCheckSummaryTypeDef
Usage Example
from mypy_boto3_support.type_defs import TrustedAdvisorCheckSummaryTypeDef
def get_value() -> TrustedAdvisorCheckSummaryTypeDef:
return {
"checkId": ...,
"timestamp": ...,
"status": ...,
"resourcesSummary": ...,
"categorySpecificSummary": ...,
}
Definition
class TrustedAdvisorCheckSummaryTypeDef(TypedDict):
checkId: str,
timestamp: str,
status: str,
resourcesSummary: TrustedAdvisorResourcesSummaryTypeDef, # (1)
categorySpecificSummary: TrustedAdvisorCategorySpecificSummaryTypeDef, # (2)
hasFlaggedResources: NotRequired[bool],
CaseDetailsTypeDef
Usage Example
from mypy_boto3_support.type_defs import CaseDetailsTypeDef
def get_value() -> CaseDetailsTypeDef:
return {
"caseId": ...,
}
Definition
class CaseDetailsTypeDef(TypedDict):
caseId: NotRequired[str],
displayId: NotRequired[str],
subject: NotRequired[str],
status: NotRequired[str],
serviceCode: NotRequired[str],
categoryCode: NotRequired[str],
severityCode: NotRequired[str],
submittedBy: NotRequired[str],
timeCreated: NotRequired[str],
recentCommunications: NotRequired[RecentCaseCommunicationsTypeDef], # (1)
ccEmailAddresses: NotRequired[List[str]],
language: NotRequired[str],
DescribeTrustedAdvisorCheckResultResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeTrustedAdvisorCheckResultResponseTypeDef
def get_value() -> DescribeTrustedAdvisorCheckResultResponseTypeDef:
return {
"result": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeTrustedAdvisorCheckResultResponseTypeDef(TypedDict):
result: TrustedAdvisorCheckResultTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeTrustedAdvisorCheckSummariesResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeTrustedAdvisorCheckSummariesResponseTypeDef
def get_value() -> DescribeTrustedAdvisorCheckSummariesResponseTypeDef:
return {
"summaries": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeTrustedAdvisorCheckSummariesResponseTypeDef(TypedDict):
summaries: List[TrustedAdvisorCheckSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeCasesResponseTypeDef
Usage Example
from mypy_boto3_support.type_defs import DescribeCasesResponseTypeDef
def get_value() -> DescribeCasesResponseTypeDef:
return {
"cases": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}