Skip to content

Type definitions#

Index > Support > Type definitions

Auto-generated documentation for Support type annotations stubs module mypy-boto3-support.

BlobTypeDef#

# BlobTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

AddCommunicationToCaseRequestRequestTypeDef#

# AddCommunicationToCaseRequestRequestTypeDef definition

class AddCommunicationToCaseRequestRequestTypeDef(TypedDict):
    communicationBody: str,
    caseId: NotRequired[str],
    ccEmailAddresses: NotRequired[Sequence[str]],
    attachmentSetId: NotRequired[str],

AttachmentDetailsTypeDef#

# AttachmentDetailsTypeDef definition

class AttachmentDetailsTypeDef(TypedDict):
    attachmentId: NotRequired[str],
    fileName: NotRequired[str],

CategoryTypeDef#

# CategoryTypeDef definition

class CategoryTypeDef(TypedDict):
    code: NotRequired[str],
    name: NotRequired[str],

DateIntervalTypeDef#

# DateIntervalTypeDef definition

class DateIntervalTypeDef(TypedDict):
    startDateTime: NotRequired[str],
    endDateTime: NotRequired[str],

SupportedHourTypeDef#

# SupportedHourTypeDef definition

class SupportedHourTypeDef(TypedDict):
    startTime: NotRequired[str],
    endTime: NotRequired[str],

CreateCaseRequestRequestTypeDef#

# CreateCaseRequestRequestTypeDef 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#

# DescribeAttachmentRequestRequestTypeDef definition

class DescribeAttachmentRequestRequestTypeDef(TypedDict):
    attachmentId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeCasesRequestRequestTypeDef#

# DescribeCasesRequestRequestTypeDef 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#

# DescribeCommunicationsRequestRequestTypeDef definition

class DescribeCommunicationsRequestRequestTypeDef(TypedDict):
    caseId: str,
    beforeTime: NotRequired[str],
    afterTime: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

DescribeCreateCaseOptionsRequestRequestTypeDef#

# DescribeCreateCaseOptionsRequestRequestTypeDef definition

class DescribeCreateCaseOptionsRequestRequestTypeDef(TypedDict):
    issueType: str,
    serviceCode: str,
    language: str,
    categoryCode: str,

DescribeServicesRequestRequestTypeDef#

# DescribeServicesRequestRequestTypeDef definition

class DescribeServicesRequestRequestTypeDef(TypedDict):
    serviceCodeList: NotRequired[Sequence[str]],
    language: NotRequired[str],

DescribeSeverityLevelsRequestRequestTypeDef#

# DescribeSeverityLevelsRequestRequestTypeDef definition

class DescribeSeverityLevelsRequestRequestTypeDef(TypedDict):
    language: NotRequired[str],

SeverityLevelTypeDef#

# SeverityLevelTypeDef definition

class SeverityLevelTypeDef(TypedDict):
    code: NotRequired[str],
    name: NotRequired[str],

DescribeSupportedLanguagesRequestRequestTypeDef#

# DescribeSupportedLanguagesRequestRequestTypeDef definition

class DescribeSupportedLanguagesRequestRequestTypeDef(TypedDict):
    issueType: str,
    serviceCode: str,
    categoryCode: str,

SupportedLanguageTypeDef#

# SupportedLanguageTypeDef definition

class SupportedLanguageTypeDef(TypedDict):
    code: NotRequired[str],
    language: NotRequired[str],
    display: NotRequired[str],

DescribeTrustedAdvisorCheckRefreshStatusesRequestRequestTypeDef#

# DescribeTrustedAdvisorCheckRefreshStatusesRequestRequestTypeDef definition

class DescribeTrustedAdvisorCheckRefreshStatusesRequestRequestTypeDef(TypedDict):
    checkIds: Sequence[str],

TrustedAdvisorCheckRefreshStatusTypeDef#

# TrustedAdvisorCheckRefreshStatusTypeDef definition

class TrustedAdvisorCheckRefreshStatusTypeDef(TypedDict):
    checkId: str,
    status: str,
    millisUntilNextRefreshable: int,

DescribeTrustedAdvisorCheckResultRequestRequestTypeDef#

# DescribeTrustedAdvisorCheckResultRequestRequestTypeDef definition

class DescribeTrustedAdvisorCheckResultRequestRequestTypeDef(TypedDict):
    checkId: str,
    language: NotRequired[str],

DescribeTrustedAdvisorCheckSummariesRequestRequestTypeDef#

# DescribeTrustedAdvisorCheckSummariesRequestRequestTypeDef definition

class DescribeTrustedAdvisorCheckSummariesRequestRequestTypeDef(TypedDict):
    checkIds: Sequence[str],

DescribeTrustedAdvisorChecksRequestRequestTypeDef#

# DescribeTrustedAdvisorChecksRequestRequestTypeDef definition

class DescribeTrustedAdvisorChecksRequestRequestTypeDef(TypedDict):
    language: str,

TrustedAdvisorCheckDescriptionTypeDef#

# TrustedAdvisorCheckDescriptionTypeDef definition

class TrustedAdvisorCheckDescriptionTypeDef(TypedDict):
    id: str,
    name: str,
    description: str,
    category: str,
    metadata: List[str],

RefreshTrustedAdvisorCheckRequestRequestTypeDef#

# RefreshTrustedAdvisorCheckRequestRequestTypeDef definition

class RefreshTrustedAdvisorCheckRequestRequestTypeDef(TypedDict):
    checkId: str,

ResolveCaseRequestRequestTypeDef#

# ResolveCaseRequestRequestTypeDef definition

class ResolveCaseRequestRequestTypeDef(TypedDict):
    caseId: NotRequired[str],

TrustedAdvisorCostOptimizingSummaryTypeDef#

# TrustedAdvisorCostOptimizingSummaryTypeDef definition

class TrustedAdvisorCostOptimizingSummaryTypeDef(TypedDict):
    estimatedMonthlySavings: float,
    estimatedPercentMonthlySavings: float,

TrustedAdvisorResourceDetailTypeDef#

# TrustedAdvisorResourceDetailTypeDef definition

class TrustedAdvisorResourceDetailTypeDef(TypedDict):
    status: str,
    resourceId: str,
    metadata: List[str],
    region: NotRequired[str],
    isSuppressed: NotRequired[bool],

TrustedAdvisorResourcesSummaryTypeDef#

# TrustedAdvisorResourcesSummaryTypeDef definition

class TrustedAdvisorResourcesSummaryTypeDef(TypedDict):
    resourcesProcessed: int,
    resourcesFlagged: int,
    resourcesIgnored: int,
    resourcesSuppressed: int,

AddAttachmentsToSetResponseTypeDef#

# AddAttachmentsToSetResponseTypeDef definition

class AddAttachmentsToSetResponseTypeDef(TypedDict):
    attachmentSetId: str,
    expiryTime: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AddCommunicationToCaseResponseTypeDef#

# AddCommunicationToCaseResponseTypeDef definition

class AddCommunicationToCaseResponseTypeDef(TypedDict):
    result: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateCaseResponseTypeDef#

# CreateCaseResponseTypeDef definition

class CreateCaseResponseTypeDef(TypedDict):
    caseId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ResolveCaseResponseTypeDef#

# ResolveCaseResponseTypeDef definition

class ResolveCaseResponseTypeDef(TypedDict):
    initialCaseStatus: str,
    finalCaseStatus: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CommunicationTypeDef#

# CommunicationTypeDef definition

class CommunicationTypeDef(TypedDict):
    caseId: NotRequired[str],
    body: NotRequired[str],
    submittedBy: NotRequired[str],
    timeCreated: NotRequired[str],
    attachmentSet: NotRequired[List[AttachmentDetailsTypeDef]],  # (1)
  1. See AttachmentDetailsTypeDef

AttachmentTypeDef#

# AttachmentTypeDef definition

class AttachmentTypeDef(TypedDict):
    fileName: NotRequired[str],
    data: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],

ServiceTypeDef#

# ServiceTypeDef definition

class ServiceTypeDef(TypedDict):
    code: NotRequired[str],
    name: NotRequired[str],
    categories: NotRequired[List[CategoryTypeDef]],  # (1)
  1. See CategoryTypeDef

CommunicationTypeOptionsTypeDef#

# CommunicationTypeOptionsTypeDef definition

class CommunicationTypeOptionsTypeDef(TypedDict):
    type: NotRequired[str],
    supportedHours: NotRequired[List[SupportedHourTypeDef]],  # (1)
    datesWithoutSupport: NotRequired[List[DateIntervalTypeDef]],  # (2)
  1. See SupportedHourTypeDef
  2. See DateIntervalTypeDef

DescribeCasesRequestDescribeCasesPaginateTypeDef#

# DescribeCasesRequestDescribeCasesPaginateTypeDef 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)
  1. See PaginatorConfigTypeDef

DescribeCommunicationsRequestDescribeCommunicationsPaginateTypeDef#

# DescribeCommunicationsRequestDescribeCommunicationsPaginateTypeDef definition

class DescribeCommunicationsRequestDescribeCommunicationsPaginateTypeDef(TypedDict):
    caseId: str,
    beforeTime: NotRequired[str],
    afterTime: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeSeverityLevelsResponseTypeDef#

# DescribeSeverityLevelsResponseTypeDef definition

class DescribeSeverityLevelsResponseTypeDef(TypedDict):
    severityLevels: List[SeverityLevelTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SeverityLevelTypeDef
  2. See ResponseMetadataTypeDef

DescribeSupportedLanguagesResponseTypeDef#

# DescribeSupportedLanguagesResponseTypeDef definition

class DescribeSupportedLanguagesResponseTypeDef(TypedDict):
    supportedLanguages: List[SupportedLanguageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SupportedLanguageTypeDef
  2. See ResponseMetadataTypeDef

DescribeTrustedAdvisorCheckRefreshStatusesResponseTypeDef#

# DescribeTrustedAdvisorCheckRefreshStatusesResponseTypeDef definition

class DescribeTrustedAdvisorCheckRefreshStatusesResponseTypeDef(TypedDict):
    statuses: List[TrustedAdvisorCheckRefreshStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TrustedAdvisorCheckRefreshStatusTypeDef
  2. See ResponseMetadataTypeDef

RefreshTrustedAdvisorCheckResponseTypeDef#

# RefreshTrustedAdvisorCheckResponseTypeDef definition

class RefreshTrustedAdvisorCheckResponseTypeDef(TypedDict):
    status: TrustedAdvisorCheckRefreshStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TrustedAdvisorCheckRefreshStatusTypeDef
  2. See ResponseMetadataTypeDef

DescribeTrustedAdvisorChecksResponseTypeDef#

# DescribeTrustedAdvisorChecksResponseTypeDef definition

class DescribeTrustedAdvisorChecksResponseTypeDef(TypedDict):
    checks: List[TrustedAdvisorCheckDescriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TrustedAdvisorCheckDescriptionTypeDef
  2. See ResponseMetadataTypeDef

TrustedAdvisorCategorySpecificSummaryTypeDef#

# TrustedAdvisorCategorySpecificSummaryTypeDef definition

class TrustedAdvisorCategorySpecificSummaryTypeDef(TypedDict):
    costOptimizing: NotRequired[TrustedAdvisorCostOptimizingSummaryTypeDef],  # (1)
  1. See TrustedAdvisorCostOptimizingSummaryTypeDef

DescribeCommunicationsResponseTypeDef#

# DescribeCommunicationsResponseTypeDef definition

class DescribeCommunicationsResponseTypeDef(TypedDict):
    communications: List[CommunicationTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CommunicationTypeDef
  2. See ResponseMetadataTypeDef

RecentCaseCommunicationsTypeDef#

# RecentCaseCommunicationsTypeDef definition

class RecentCaseCommunicationsTypeDef(TypedDict):
    communications: NotRequired[List[CommunicationTypeDef]],  # (1)
    nextToken: NotRequired[str],
  1. See CommunicationTypeDef

AddAttachmentsToSetRequestRequestTypeDef#

# AddAttachmentsToSetRequestRequestTypeDef definition

class AddAttachmentsToSetRequestRequestTypeDef(TypedDict):
    attachments: Sequence[AttachmentTypeDef],  # (1)
    attachmentSetId: NotRequired[str],
  1. See AttachmentTypeDef

DescribeAttachmentResponseTypeDef#

# DescribeAttachmentResponseTypeDef definition

class DescribeAttachmentResponseTypeDef(TypedDict):
    attachment: AttachmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AttachmentTypeDef
  2. See ResponseMetadataTypeDef

DescribeServicesResponseTypeDef#

# DescribeServicesResponseTypeDef definition

class DescribeServicesResponseTypeDef(TypedDict):
    services: List[ServiceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServiceTypeDef
  2. See ResponseMetadataTypeDef

DescribeCreateCaseOptionsResponseTypeDef#

# DescribeCreateCaseOptionsResponseTypeDef definition

class DescribeCreateCaseOptionsResponseTypeDef(TypedDict):
    languageAvailability: str,
    communicationTypes: List[CommunicationTypeOptionsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CommunicationTypeOptionsTypeDef
  2. See ResponseMetadataTypeDef

TrustedAdvisorCheckResultTypeDef#

# TrustedAdvisorCheckResultTypeDef definition

class TrustedAdvisorCheckResultTypeDef(TypedDict):
    checkId: str,
    timestamp: str,
    status: str,
    resourcesSummary: TrustedAdvisorResourcesSummaryTypeDef,  # (1)
    categorySpecificSummary: TrustedAdvisorCategorySpecificSummaryTypeDef,  # (2)
    flaggedResources: List[TrustedAdvisorResourceDetailTypeDef],  # (3)
  1. See TrustedAdvisorResourcesSummaryTypeDef
  2. See TrustedAdvisorCategorySpecificSummaryTypeDef
  3. See TrustedAdvisorResourceDetailTypeDef

TrustedAdvisorCheckSummaryTypeDef#

# TrustedAdvisorCheckSummaryTypeDef definition

class TrustedAdvisorCheckSummaryTypeDef(TypedDict):
    checkId: str,
    timestamp: str,
    status: str,
    resourcesSummary: TrustedAdvisorResourcesSummaryTypeDef,  # (1)
    categorySpecificSummary: TrustedAdvisorCategorySpecificSummaryTypeDef,  # (2)
    hasFlaggedResources: NotRequired[bool],
  1. See TrustedAdvisorResourcesSummaryTypeDef
  2. See TrustedAdvisorCategorySpecificSummaryTypeDef

CaseDetailsTypeDef#

# CaseDetailsTypeDef 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],
  1. See RecentCaseCommunicationsTypeDef

DescribeTrustedAdvisorCheckResultResponseTypeDef#

# DescribeTrustedAdvisorCheckResultResponseTypeDef definition

class DescribeTrustedAdvisorCheckResultResponseTypeDef(TypedDict):
    result: TrustedAdvisorCheckResultTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TrustedAdvisorCheckResultTypeDef
  2. See ResponseMetadataTypeDef

DescribeTrustedAdvisorCheckSummariesResponseTypeDef#

# DescribeTrustedAdvisorCheckSummariesResponseTypeDef definition

class DescribeTrustedAdvisorCheckSummariesResponseTypeDef(TypedDict):
    summaries: List[TrustedAdvisorCheckSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TrustedAdvisorCheckSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeCasesResponseTypeDef#

# DescribeCasesResponseTypeDef definition

class DescribeCasesResponseTypeDef(TypedDict):
    cases: List[CaseDetailsTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CaseDetailsTypeDef
  2. See ResponseMetadataTypeDef