Skip to content

Type definitions#

Index > ConnectCases > Type definitions

Auto-generated documentation for ConnectCases type annotations stubs module types-boto3-connectcases.

FieldValueUnionUnionTypeDef#

# FieldValueUnionUnionTypeDef definition

FieldValueUnionUnionTypeDef = Union[
    FieldValueUnionTypeDef,  # (1)
    FieldValueUnionOutputTypeDef,  # (2)
]
  1. See FieldValueUnionTypeDef
  2. See FieldValueUnionOutputTypeDef

CaseEventIncludedDataUnionTypeDef#

# CaseEventIncludedDataUnionTypeDef definition

CaseEventIncludedDataUnionTypeDef = Union[
    CaseEventIncludedDataTypeDef,  # (1)
    CaseEventIncludedDataOutputTypeDef,  # (2)
]
  1. See CaseEventIncludedDataTypeDef
  2. See CaseEventIncludedDataOutputTypeDef

FieldGroupUnionTypeDef#

# FieldGroupUnionTypeDef definition

FieldGroupUnionTypeDef = Union[
    FieldGroupTypeDef,  # (1)
    FieldGroupOutputTypeDef,  # (2)
]
  1. See FieldGroupTypeDef
  2. See FieldGroupOutputTypeDef

FieldValueExtraUnionTypeDef#

# FieldValueExtraUnionTypeDef definition

FieldValueExtraUnionTypeDef = Union[
    FieldValueTypeDef,  # (1)
    FieldValueOutputTypeDef,  # (2)
]
  1. See FieldValueTypeDef
  2. See FieldValueOutputTypeDef

EventIncludedDataUnionTypeDef#

# EventIncludedDataUnionTypeDef definition

EventIncludedDataUnionTypeDef = Union[
    EventIncludedDataTypeDef,  # (1)
    EventIncludedDataOutputTypeDef,  # (2)
]
  1. See EventIncludedDataTypeDef
  2. See EventIncludedDataOutputTypeDef

SectionUnionTypeDef#

# SectionUnionTypeDef definition

SectionUnionTypeDef = Union[
    SectionTypeDef,  # (1)
    SectionOutputTypeDef,  # (2)
]
  1. See SectionTypeDef
  2. See SectionOutputTypeDef

LayoutSectionsUnionTypeDef#

# LayoutSectionsUnionTypeDef definition

LayoutSectionsUnionTypeDef = Union[
    LayoutSectionsTypeDef,  # (1)
    LayoutSectionsOutputTypeDef,  # (2)
]
  1. See LayoutSectionsTypeDef
  2. See LayoutSectionsOutputTypeDef

BasicLayoutUnionTypeDef#

# BasicLayoutUnionTypeDef definition

BasicLayoutUnionTypeDef = Union[
    BasicLayoutTypeDef,  # (1)
    BasicLayoutOutputTypeDef,  # (2)
]
  1. See BasicLayoutTypeDef
  2. See BasicLayoutOutputTypeDef

AuditEventFieldValueUnionTypeDef#

# AuditEventFieldValueUnionTypeDef definition

class AuditEventFieldValueUnionTypeDef(TypedDict):
    booleanValue: NotRequired[bool],
    doubleValue: NotRequired[float],
    emptyValue: NotRequired[dict[str, Any]],
    stringValue: NotRequired[str],
    userArnValue: NotRequired[str],

UserUnionTypeDef#

# UserUnionTypeDef definition

class UserUnionTypeDef(TypedDict):
    userArn: NotRequired[str],

FieldIdentifierTypeDef#

# FieldIdentifierTypeDef definition

class FieldIdentifierTypeDef(TypedDict):
    id: str,

FieldErrorTypeDef#

# FieldErrorTypeDef definition

class FieldErrorTypeDef(TypedDict):
    errorCode: str,
    id: str,
    message: NotRequired[str],

GetFieldResponseTypeDef#

# GetFieldResponseTypeDef definition

class GetFieldResponseTypeDef(TypedDict):
    fieldArn: str,
    fieldId: str,
    name: str,
    namespace: FieldNamespaceType,  # (1)
    type: FieldTypeType,  # (2)
    createdTime: NotRequired[datetime],
    deleted: NotRequired[bool],
    description: NotRequired[str],
    lastModifiedTime: NotRequired[datetime],
    tags: NotRequired[dict[str, str]],
  1. See FieldNamespaceType
  2. See FieldTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

FieldOptionTypeDef#

# FieldOptionTypeDef definition

class FieldOptionTypeDef(TypedDict):
    active: bool,
    name: str,
    value: str,

FieldOptionErrorTypeDef#

# FieldOptionErrorTypeDef definition

class FieldOptionErrorTypeDef(TypedDict):
    errorCode: str,
    message: str,
    value: str,

CaseSummaryTypeDef#

# CaseSummaryTypeDef definition

class CaseSummaryTypeDef(TypedDict):
    caseId: str,
    templateId: str,

CommentContentTypeDef#

# CommentContentTypeDef definition

class CommentContentTypeDef(TypedDict):
    body: str,
    contentType: CommentBodyTextTypeType,  # (1)
  1. See CommentBodyTextTypeType

ContactContentTypeDef#

# ContactContentTypeDef definition

class ContactContentTypeDef(TypedDict):
    channel: str,
    connectedToSystemTime: datetime,
    contactArn: str,

ContactFilterTypeDef#

# ContactFilterTypeDef definition

class ContactFilterTypeDef(TypedDict):
    channel: NotRequired[Sequence[str]],
    contactArn: NotRequired[str],

ContactTypeDef#

# ContactTypeDef definition

class ContactTypeDef(TypedDict):
    contactArn: str,

CreateDomainRequestRequestTypeDef#

# CreateDomainRequestRequestTypeDef definition

class CreateDomainRequestRequestTypeDef(TypedDict):
    name: str,

CreateFieldRequestRequestTypeDef#

# CreateFieldRequestRequestTypeDef definition

class CreateFieldRequestRequestTypeDef(TypedDict):
    domainId: str,
    name: str,
    type: FieldTypeType,  # (1)
    description: NotRequired[str],
  1. See FieldTypeType

LayoutConfigurationTypeDef#

# LayoutConfigurationTypeDef definition

class LayoutConfigurationTypeDef(TypedDict):
    defaultLayout: NotRequired[str],

RequiredFieldTypeDef#

# RequiredFieldTypeDef definition

class RequiredFieldTypeDef(TypedDict):
    fieldId: str,

DeleteDomainRequestRequestTypeDef#

# DeleteDomainRequestRequestTypeDef definition

class DeleteDomainRequestRequestTypeDef(TypedDict):
    domainId: str,

DeleteFieldRequestRequestTypeDef#

# DeleteFieldRequestRequestTypeDef definition

class DeleteFieldRequestRequestTypeDef(TypedDict):
    domainId: str,
    fieldId: str,

DeleteLayoutRequestRequestTypeDef#

# DeleteLayoutRequestRequestTypeDef definition

class DeleteLayoutRequestRequestTypeDef(TypedDict):
    domainId: str,
    layoutId: str,

DeleteTemplateRequestRequestTypeDef#

# DeleteTemplateRequestRequestTypeDef definition

class DeleteTemplateRequestRequestTypeDef(TypedDict):
    domainId: str,
    templateId: str,

DomainSummaryTypeDef#

# DomainSummaryTypeDef definition

class DomainSummaryTypeDef(TypedDict):
    domainArn: str,
    domainId: str,
    name: str,

RelatedItemEventIncludedDataTypeDef#

# RelatedItemEventIncludedDataTypeDef definition

class RelatedItemEventIncludedDataTypeDef(TypedDict):
    includeContent: bool,

FieldItemTypeDef#

# FieldItemTypeDef definition

class FieldItemTypeDef(TypedDict):
    id: str,

FieldSummaryTypeDef#

# FieldSummaryTypeDef definition

class FieldSummaryTypeDef(TypedDict):
    fieldArn: str,
    fieldId: str,
    name: str,
    namespace: FieldNamespaceType,  # (1)
    type: FieldTypeType,  # (2)
  1. See FieldNamespaceType
  2. See FieldTypeType

FieldValueUnionOutputTypeDef#

# FieldValueUnionOutputTypeDef definition

class FieldValueUnionOutputTypeDef(TypedDict):
    booleanValue: NotRequired[bool],
    doubleValue: NotRequired[float],
    emptyValue: NotRequired[dict[str, Any]],
    stringValue: NotRequired[str],
    userArnValue: NotRequired[str],

FieldValueUnionTypeDef#

# FieldValueUnionTypeDef definition

class FieldValueUnionTypeDef(TypedDict):
    booleanValue: NotRequired[bool],
    doubleValue: NotRequired[float],
    emptyValue: NotRequired[Mapping[str, Any]],
    stringValue: NotRequired[str],
    userArnValue: NotRequired[str],

FileContentTypeDef#

# FileContentTypeDef definition

class FileContentTypeDef(TypedDict):
    fileArn: str,

FileFilterTypeDef#

# FileFilterTypeDef definition

class FileFilterTypeDef(TypedDict):
    fileArn: NotRequired[str],

GetCaseAuditEventsRequestRequestTypeDef#

# GetCaseAuditEventsRequestRequestTypeDef definition

class GetCaseAuditEventsRequestRequestTypeDef(TypedDict):
    caseId: str,
    domainId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

GetCaseEventConfigurationRequestRequestTypeDef#

# GetCaseEventConfigurationRequestRequestTypeDef definition

class GetCaseEventConfigurationRequestRequestTypeDef(TypedDict):
    domainId: str,

GetDomainRequestRequestTypeDef#

# GetDomainRequestRequestTypeDef definition

class GetDomainRequestRequestTypeDef(TypedDict):
    domainId: str,

GetLayoutRequestRequestTypeDef#

# GetLayoutRequestRequestTypeDef definition

class GetLayoutRequestRequestTypeDef(TypedDict):
    domainId: str,
    layoutId: str,

GetTemplateRequestRequestTypeDef#

# GetTemplateRequestRequestTypeDef definition

class GetTemplateRequestRequestTypeDef(TypedDict):
    domainId: str,
    templateId: str,

LayoutSummaryTypeDef#

# LayoutSummaryTypeDef definition

class LayoutSummaryTypeDef(TypedDict):
    layoutArn: str,
    layoutId: str,
    name: str,

ListCasesForContactRequestRequestTypeDef#

# ListCasesForContactRequestRequestTypeDef definition

class ListCasesForContactRequestRequestTypeDef(TypedDict):
    contactArn: str,
    domainId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListDomainsRequestRequestTypeDef#

# ListDomainsRequestRequestTypeDef definition

class ListDomainsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListFieldOptionsRequestRequestTypeDef#

# ListFieldOptionsRequestRequestTypeDef definition

class ListFieldOptionsRequestRequestTypeDef(TypedDict):
    domainId: str,
    fieldId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    values: NotRequired[Sequence[str]],

ListFieldsRequestRequestTypeDef#

# ListFieldsRequestRequestTypeDef definition

class ListFieldsRequestRequestTypeDef(TypedDict):
    domainId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListLayoutsRequestRequestTypeDef#

# ListLayoutsRequestRequestTypeDef definition

class ListLayoutsRequestRequestTypeDef(TypedDict):
    domainId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    arn: str,

ListTemplatesRequestRequestTypeDef#

# ListTemplatesRequestRequestTypeDef definition

class ListTemplatesRequestRequestTypeDef(TypedDict):
    domainId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    status: NotRequired[Sequence[TemplateStatusType]],  # (1)
  1. See TemplateStatusType

TemplateSummaryTypeDef#

# TemplateSummaryTypeDef definition

class TemplateSummaryTypeDef(TypedDict):
    name: str,
    status: TemplateStatusType,  # (1)
    templateArn: str,
    templateId: str,
  1. See TemplateStatusType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

SortTypeDef#

# SortTypeDef definition

class SortTypeDef(TypedDict):
    fieldId: str,
    sortOrder: OrderType,  # (1)
  1. See OrderType

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    arn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    arn: str,
    tagKeys: Sequence[str],

UpdateFieldRequestRequestTypeDef#

# UpdateFieldRequestRequestTypeDef definition

class UpdateFieldRequestRequestTypeDef(TypedDict):
    domainId: str,
    fieldId: str,
    description: NotRequired[str],
    name: NotRequired[str],

AuditEventFieldTypeDef#

# AuditEventFieldTypeDef definition

class AuditEventFieldTypeDef(TypedDict):
    eventFieldId: str,
    newValue: AuditEventFieldValueUnionTypeDef,  # (1)
    oldValue: NotRequired[AuditEventFieldValueUnionTypeDef],  # (1)
  1. See AuditEventFieldValueUnionTypeDef
  2. See AuditEventFieldValueUnionTypeDef

AuditEventPerformedByTypeDef#

# AuditEventPerformedByTypeDef definition

class AuditEventPerformedByTypeDef(TypedDict):
    iamPrincipalArn: str,
    user: NotRequired[UserUnionTypeDef],  # (1)
  1. See UserUnionTypeDef

BatchGetFieldRequestRequestTypeDef#

# BatchGetFieldRequestRequestTypeDef definition

class BatchGetFieldRequestRequestTypeDef(TypedDict):
    domainId: str,
    fields: Sequence[FieldIdentifierTypeDef],  # (1)
  1. See FieldIdentifierTypeDef

CaseEventIncludedDataOutputTypeDef#

# CaseEventIncludedDataOutputTypeDef definition

class CaseEventIncludedDataOutputTypeDef(TypedDict):
    fields: list[FieldIdentifierTypeDef],  # (1)
  1. See FieldIdentifierTypeDef

CaseEventIncludedDataTypeDef#

# CaseEventIncludedDataTypeDef definition

class CaseEventIncludedDataTypeDef(TypedDict):
    fields: Sequence[FieldIdentifierTypeDef],  # (1)
  1. See FieldIdentifierTypeDef

GetCaseRequestRequestTypeDef#

# GetCaseRequestRequestTypeDef definition

class GetCaseRequestRequestTypeDef(TypedDict):
    caseId: str,
    domainId: str,
    fields: Sequence[FieldIdentifierTypeDef],  # (1)
    nextToken: NotRequired[str],
  1. See FieldIdentifierTypeDef

BatchGetFieldResponseTypeDef#

# BatchGetFieldResponseTypeDef definition

class BatchGetFieldResponseTypeDef(TypedDict):
    errors: list[FieldErrorTypeDef],  # (1)
    fields: list[GetFieldResponseTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FieldErrorTypeDef
  2. See GetFieldResponseTypeDef
  3. See ResponseMetadataTypeDef

CreateCaseResponseTypeDef#

# CreateCaseResponseTypeDef definition

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

CreateDomainResponseTypeDef#

# CreateDomainResponseTypeDef definition

class CreateDomainResponseTypeDef(TypedDict):
    domainArn: str,
    domainId: str,
    domainStatus: DomainStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainStatusType
  2. See ResponseMetadataTypeDef

CreateFieldResponseTypeDef#

# CreateFieldResponseTypeDef definition

class CreateFieldResponseTypeDef(TypedDict):
    fieldArn: str,
    fieldId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLayoutResponseTypeDef#

# CreateLayoutResponseTypeDef definition

class CreateLayoutResponseTypeDef(TypedDict):
    layoutArn: str,
    layoutId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateRelatedItemResponseTypeDef#

# CreateRelatedItemResponseTypeDef definition

class CreateRelatedItemResponseTypeDef(TypedDict):
    relatedItemArn: str,
    relatedItemId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTemplateResponseTypeDef#

# CreateTemplateResponseTypeDef definition

class CreateTemplateResponseTypeDef(TypedDict):
    templateArn: str,
    templateId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

GetDomainResponseTypeDef#

# GetDomainResponseTypeDef definition

class GetDomainResponseTypeDef(TypedDict):
    createdTime: datetime,
    domainArn: str,
    domainId: str,
    domainStatus: DomainStatusType,  # (1)
    name: str,
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainStatusType
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

BatchPutFieldOptionsRequestRequestTypeDef#

# BatchPutFieldOptionsRequestRequestTypeDef definition

class BatchPutFieldOptionsRequestRequestTypeDef(TypedDict):
    domainId: str,
    fieldId: str,
    options: Sequence[FieldOptionTypeDef],  # (1)
  1. See FieldOptionTypeDef

ListFieldOptionsResponseTypeDef#

# ListFieldOptionsResponseTypeDef definition

class ListFieldOptionsResponseTypeDef(TypedDict):
    options: list[FieldOptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See FieldOptionTypeDef
  2. See ResponseMetadataTypeDef

BatchPutFieldOptionsResponseTypeDef#

# BatchPutFieldOptionsResponseTypeDef definition

class BatchPutFieldOptionsResponseTypeDef(TypedDict):
    errors: list[FieldOptionErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FieldOptionErrorTypeDef
  2. See ResponseMetadataTypeDef

ListCasesForContactResponseTypeDef#

# ListCasesForContactResponseTypeDef definition

class ListCasesForContactResponseTypeDef(TypedDict):
    cases: list[CaseSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See CaseSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateTemplateRequestRequestTypeDef#

# CreateTemplateRequestRequestTypeDef definition

class CreateTemplateRequestRequestTypeDef(TypedDict):
    domainId: str,
    name: str,
    description: NotRequired[str],
    layoutConfiguration: NotRequired[LayoutConfigurationTypeDef],  # (1)
    requiredFields: NotRequired[Sequence[RequiredFieldTypeDef]],  # (2)
    status: NotRequired[TemplateStatusType],  # (3)
  1. See LayoutConfigurationTypeDef
  2. See RequiredFieldTypeDef
  3. See TemplateStatusType

GetTemplateResponseTypeDef#

# GetTemplateResponseTypeDef definition

class GetTemplateResponseTypeDef(TypedDict):
    createdTime: datetime,
    deleted: bool,
    description: str,
    lastModifiedTime: datetime,
    layoutConfiguration: LayoutConfigurationTypeDef,  # (1)
    name: str,
    requiredFields: list[RequiredFieldTypeDef],  # (2)
    status: TemplateStatusType,  # (3)
    tags: dict[str, str],
    templateArn: str,
    templateId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See LayoutConfigurationTypeDef
  2. See RequiredFieldTypeDef
  3. See TemplateStatusType
  4. See ResponseMetadataTypeDef

UpdateTemplateRequestRequestTypeDef#

# UpdateTemplateRequestRequestTypeDef definition

class UpdateTemplateRequestRequestTypeDef(TypedDict):
    domainId: str,
    templateId: str,
    description: NotRequired[str],
    layoutConfiguration: NotRequired[LayoutConfigurationTypeDef],  # (1)
    name: NotRequired[str],
    requiredFields: NotRequired[Sequence[RequiredFieldTypeDef]],  # (2)
    status: NotRequired[TemplateStatusType],  # (3)
  1. See LayoutConfigurationTypeDef
  2. See RequiredFieldTypeDef
  3. See TemplateStatusType

ListDomainsResponseTypeDef#

# ListDomainsResponseTypeDef definition

class ListDomainsResponseTypeDef(TypedDict):
    domains: list[DomainSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DomainSummaryTypeDef
  2. See ResponseMetadataTypeDef

FieldGroupOutputTypeDef#

# FieldGroupOutputTypeDef definition

class FieldGroupOutputTypeDef(TypedDict):
    fields: list[FieldItemTypeDef],  # (1)
    name: NotRequired[str],
  1. See FieldItemTypeDef

FieldGroupTypeDef#

# FieldGroupTypeDef definition

class FieldGroupTypeDef(TypedDict):
    fields: Sequence[FieldItemTypeDef],  # (1)
    name: NotRequired[str],
  1. See FieldItemTypeDef

ListFieldsResponseTypeDef#

# ListFieldsResponseTypeDef definition

class ListFieldsResponseTypeDef(TypedDict):
    fields: list[FieldSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See FieldSummaryTypeDef
  2. See ResponseMetadataTypeDef

FieldValueOutputTypeDef#

# FieldValueOutputTypeDef definition

class FieldValueOutputTypeDef(TypedDict):
    id: str,
    value: FieldValueUnionOutputTypeDef,  # (1)
  1. See FieldValueUnionOutputTypeDef

RelatedItemContentTypeDef#

# RelatedItemContentTypeDef definition

class RelatedItemContentTypeDef(TypedDict):
    comment: NotRequired[CommentContentTypeDef],  # (1)
    contact: NotRequired[ContactContentTypeDef],  # (2)
    file: NotRequired[FileContentTypeDef],  # (3)
  1. See CommentContentTypeDef
  2. See ContactContentTypeDef
  3. See FileContentTypeDef

RelatedItemInputContentTypeDef#

# RelatedItemInputContentTypeDef definition

class RelatedItemInputContentTypeDef(TypedDict):
    comment: NotRequired[CommentContentTypeDef],  # (1)
    contact: NotRequired[ContactTypeDef],  # (2)
    file: NotRequired[FileContentTypeDef],  # (3)
  1. See CommentContentTypeDef
  2. See ContactTypeDef
  3. See FileContentTypeDef

RelatedItemTypeFilterTypeDef#

# RelatedItemTypeFilterTypeDef definition

class RelatedItemTypeFilterTypeDef(TypedDict):
    comment: NotRequired[Mapping[str, Any]],
    contact: NotRequired[ContactFilterTypeDef],  # (1)
    file: NotRequired[FileFilterTypeDef],  # (2)
  1. See ContactFilterTypeDef
  2. See FileFilterTypeDef

ListLayoutsResponseTypeDef#

# ListLayoutsResponseTypeDef definition

class ListLayoutsResponseTypeDef(TypedDict):
    layouts: list[LayoutSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See LayoutSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTemplatesResponseTypeDef#

# ListTemplatesResponseTypeDef definition

class ListTemplatesResponseTypeDef(TypedDict):
    templates: list[TemplateSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See TemplateSummaryTypeDef
  2. See ResponseMetadataTypeDef

AuditEventTypeDef#

# AuditEventTypeDef definition

class AuditEventTypeDef(TypedDict):
    eventId: str,
    fields: list[AuditEventFieldTypeDef],  # (1)
    performedTime: datetime,
    type: AuditEventTypeType,  # (4)
    performedBy: NotRequired[AuditEventPerformedByTypeDef],  # (2)
    relatedItemType: NotRequired[RelatedItemTypeType],  # (3)
  1. See AuditEventFieldTypeDef
  2. See AuditEventPerformedByTypeDef
  3. See RelatedItemTypeType
  4. See AuditEventTypeType

EventIncludedDataOutputTypeDef#

# EventIncludedDataOutputTypeDef definition

class EventIncludedDataOutputTypeDef(TypedDict):
    caseData: NotRequired[CaseEventIncludedDataOutputTypeDef],  # (1)
    relatedItemData: NotRequired[RelatedItemEventIncludedDataTypeDef],  # (2)
  1. See CaseEventIncludedDataOutputTypeDef
  2. See RelatedItemEventIncludedDataTypeDef

SectionOutputTypeDef#

# SectionOutputTypeDef definition

class SectionOutputTypeDef(TypedDict):
    fieldGroup: NotRequired[FieldGroupOutputTypeDef],  # (1)
  1. See FieldGroupOutputTypeDef

GetCaseResponseTypeDef#

# GetCaseResponseTypeDef definition

class GetCaseResponseTypeDef(TypedDict):
    fields: list[FieldValueOutputTypeDef],  # (1)
    tags: dict[str, str],
    templateId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See FieldValueOutputTypeDef
  2. See ResponseMetadataTypeDef

SearchCasesResponseItemTypeDef#

# SearchCasesResponseItemTypeDef definition

class SearchCasesResponseItemTypeDef(TypedDict):
    caseId: str,
    fields: list[FieldValueOutputTypeDef],  # (1)
    templateId: str,
    tags: NotRequired[dict[str, str]],
  1. See FieldValueOutputTypeDef

FieldValueTypeDef#

# FieldValueTypeDef definition

class FieldValueTypeDef(TypedDict):
    id: str,
    value: FieldValueUnionUnionTypeDef,  # (1)
  1. See FieldValueUnionTypeDef FieldValueUnionOutputTypeDef

SearchRelatedItemsResponseItemTypeDef#

# SearchRelatedItemsResponseItemTypeDef definition

class SearchRelatedItemsResponseItemTypeDef(TypedDict):
    associationTime: datetime,
    content: RelatedItemContentTypeDef,  # (1)
    relatedItemId: str,
    type: RelatedItemTypeType,  # (3)
    performedBy: NotRequired[UserUnionTypeDef],  # (2)
    tags: NotRequired[dict[str, str]],
  1. See RelatedItemContentTypeDef
  2. See UserUnionTypeDef
  3. See RelatedItemTypeType

CreateRelatedItemRequestRequestTypeDef#

# CreateRelatedItemRequestRequestTypeDef definition

class CreateRelatedItemRequestRequestTypeDef(TypedDict):
    caseId: str,
    content: RelatedItemInputContentTypeDef,  # (1)
    domainId: str,
    type: RelatedItemTypeType,  # (2)
    performedBy: NotRequired[UserUnionTypeDef],  # (3)
  1. See RelatedItemInputContentTypeDef
  2. See RelatedItemTypeType
  3. See UserUnionTypeDef

SearchRelatedItemsRequestPaginateTypeDef#

# SearchRelatedItemsRequestPaginateTypeDef definition

class SearchRelatedItemsRequestPaginateTypeDef(TypedDict):
    caseId: str,
    domainId: str,
    filters: NotRequired[Sequence[RelatedItemTypeFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See RelatedItemTypeFilterTypeDef
  2. See PaginatorConfigTypeDef

SearchRelatedItemsRequestRequestTypeDef#

# SearchRelatedItemsRequestRequestTypeDef definition

class SearchRelatedItemsRequestRequestTypeDef(TypedDict):
    caseId: str,
    domainId: str,
    filters: NotRequired[Sequence[RelatedItemTypeFilterTypeDef]],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See RelatedItemTypeFilterTypeDef

GetCaseAuditEventsResponseTypeDef#

# GetCaseAuditEventsResponseTypeDef definition

class GetCaseAuditEventsResponseTypeDef(TypedDict):
    auditEvents: list[AuditEventTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AuditEventTypeDef
  2. See ResponseMetadataTypeDef

EventBridgeConfigurationOutputTypeDef#

# EventBridgeConfigurationOutputTypeDef definition

class EventBridgeConfigurationOutputTypeDef(TypedDict):
    enabled: bool,
    includedData: NotRequired[EventIncludedDataOutputTypeDef],  # (1)
  1. See EventIncludedDataOutputTypeDef

EventIncludedDataTypeDef#

# EventIncludedDataTypeDef definition

class EventIncludedDataTypeDef(TypedDict):
    caseData: NotRequired[CaseEventIncludedDataUnionTypeDef],  # (1)
    relatedItemData: NotRequired[RelatedItemEventIncludedDataTypeDef],  # (2)
  1. See CaseEventIncludedDataTypeDef CaseEventIncludedDataOutputTypeDef
  2. See RelatedItemEventIncludedDataTypeDef

LayoutSectionsOutputTypeDef#

# LayoutSectionsOutputTypeDef definition

class LayoutSectionsOutputTypeDef(TypedDict):
    sections: NotRequired[list[SectionOutputTypeDef]],  # (1)
  1. See SectionOutputTypeDef

SectionTypeDef#

# SectionTypeDef definition

class SectionTypeDef(TypedDict):
    fieldGroup: NotRequired[FieldGroupUnionTypeDef],  # (1)
  1. See FieldGroupTypeDef FieldGroupOutputTypeDef

SearchCasesResponseTypeDef#

# SearchCasesResponseTypeDef definition

class SearchCasesResponseTypeDef(TypedDict):
    cases: list[SearchCasesResponseItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See SearchCasesResponseItemTypeDef
  2. See ResponseMetadataTypeDef

UpdateCaseRequestRequestTypeDef#

# UpdateCaseRequestRequestTypeDef definition

class UpdateCaseRequestRequestTypeDef(TypedDict):
    caseId: str,
    domainId: str,
    fields: Sequence[FieldValueTypeDef],  # (1)
    performedBy: NotRequired[UserUnionTypeDef],  # (2)
  1. See FieldValueTypeDef
  2. See UserUnionTypeDef

SearchRelatedItemsResponseTypeDef#

# SearchRelatedItemsResponseTypeDef definition

class SearchRelatedItemsResponseTypeDef(TypedDict):
    relatedItems: list[SearchRelatedItemsResponseItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See SearchRelatedItemsResponseItemTypeDef
  2. See ResponseMetadataTypeDef

GetCaseEventConfigurationResponseTypeDef#

# GetCaseEventConfigurationResponseTypeDef definition

class GetCaseEventConfigurationResponseTypeDef(TypedDict):
    eventBridge: EventBridgeConfigurationOutputTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventBridgeConfigurationOutputTypeDef
  2. See ResponseMetadataTypeDef

BasicLayoutOutputTypeDef#

# BasicLayoutOutputTypeDef definition

class BasicLayoutOutputTypeDef(TypedDict):
    moreInfo: NotRequired[LayoutSectionsOutputTypeDef],  # (1)
    topPanel: NotRequired[LayoutSectionsOutputTypeDef],  # (1)
  1. See LayoutSectionsOutputTypeDef
  2. See LayoutSectionsOutputTypeDef

CreateCaseRequestRequestTypeDef#

# CreateCaseRequestRequestTypeDef definition

class CreateCaseRequestRequestTypeDef(TypedDict):
    domainId: str,
    fields: Sequence[FieldValueExtraUnionTypeDef],  # (1)
    templateId: str,
    clientToken: NotRequired[str],
    performedBy: NotRequired[UserUnionTypeDef],  # (2)
  1. See FieldValueTypeDef FieldValueOutputTypeDef
  2. See UserUnionTypeDef

FieldFilterTypeDef#

# FieldFilterTypeDef definition

class FieldFilterTypeDef(TypedDict):
    contains: NotRequired[FieldValueExtraUnionTypeDef],  # (1)
    equalTo: NotRequired[FieldValueExtraUnionTypeDef],  # (1)
    greaterThan: NotRequired[FieldValueExtraUnionTypeDef],  # (1)
    greaterThanOrEqualTo: NotRequired[FieldValueExtraUnionTypeDef],  # (1)
    lessThan: NotRequired[FieldValueExtraUnionTypeDef],  # (1)
    lessThanOrEqualTo: NotRequired[FieldValueExtraUnionTypeDef],  # (1)
  1. See FieldValueTypeDef FieldValueOutputTypeDef
  2. See FieldValueTypeDef FieldValueOutputTypeDef
  3. See FieldValueTypeDef FieldValueOutputTypeDef
  4. See FieldValueTypeDef FieldValueOutputTypeDef
  5. See FieldValueTypeDef FieldValueOutputTypeDef
  6. See FieldValueTypeDef FieldValueOutputTypeDef

EventBridgeConfigurationTypeDef#

# EventBridgeConfigurationTypeDef definition

class EventBridgeConfigurationTypeDef(TypedDict):
    enabled: bool,
    includedData: NotRequired[EventIncludedDataUnionTypeDef],  # (1)
  1. See EventIncludedDataTypeDef EventIncludedDataOutputTypeDef

LayoutContentOutputTypeDef#

# LayoutContentOutputTypeDef definition

class LayoutContentOutputTypeDef(TypedDict):
    basic: NotRequired[BasicLayoutOutputTypeDef],  # (1)
  1. See BasicLayoutOutputTypeDef

LayoutSectionsTypeDef#

# LayoutSectionsTypeDef definition

class LayoutSectionsTypeDef(TypedDict):
    sections: NotRequired[Sequence[SectionUnionTypeDef]],  # (1)
  1. See SectionTypeDef SectionOutputTypeDef

CaseFilterPaginatorTypeDef#

# CaseFilterPaginatorTypeDef definition

class CaseFilterPaginatorTypeDef(TypedDict):
    andAll: NotRequired[Sequence[Mapping[str, Any]]],
    field: NotRequired[FieldFilterTypeDef],  # (1)
    not: NotRequired[Mapping[str, Any]],
    orAll: NotRequired[Sequence[Mapping[str, Any]]],
  1. See FieldFilterTypeDef

CaseFilterTypeDef#

# CaseFilterTypeDef definition

class CaseFilterTypeDef(TypedDict):
    andAll: NotRequired[Sequence[Mapping[str, Any]]],
    field: NotRequired[FieldFilterTypeDef],  # (1)
    not: NotRequired[Mapping[str, Any]],
    orAll: NotRequired[Sequence[Mapping[str, Any]]],
  1. See FieldFilterTypeDef

PutCaseEventConfigurationRequestRequestTypeDef#

# PutCaseEventConfigurationRequestRequestTypeDef definition

class PutCaseEventConfigurationRequestRequestTypeDef(TypedDict):
    domainId: str,
    eventBridge: EventBridgeConfigurationTypeDef,  # (1)
  1. See EventBridgeConfigurationTypeDef

GetLayoutResponseTypeDef#

# GetLayoutResponseTypeDef definition

class GetLayoutResponseTypeDef(TypedDict):
    content: LayoutContentOutputTypeDef,  # (1)
    createdTime: datetime,
    deleted: bool,
    lastModifiedTime: datetime,
    layoutArn: str,
    layoutId: str,
    name: str,
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LayoutContentOutputTypeDef
  2. See ResponseMetadataTypeDef

SearchCasesRequestPaginateTypeDef#

# SearchCasesRequestPaginateTypeDef definition

class SearchCasesRequestPaginateTypeDef(TypedDict):
    domainId: str,
    fields: NotRequired[Sequence[FieldIdentifierTypeDef]],  # (1)
    filter: NotRequired[CaseFilterPaginatorTypeDef],  # (2)
    searchTerm: NotRequired[str],
    sorts: NotRequired[Sequence[SortTypeDef]],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See FieldIdentifierTypeDef
  2. See CaseFilterPaginatorTypeDef
  3. See SortTypeDef
  4. See PaginatorConfigTypeDef

SearchCasesRequestRequestTypeDef#

# SearchCasesRequestRequestTypeDef definition

class SearchCasesRequestRequestTypeDef(TypedDict):
    domainId: str,
    fields: NotRequired[Sequence[FieldIdentifierTypeDef]],  # (1)
    filter: NotRequired[CaseFilterTypeDef],  # (2)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    searchTerm: NotRequired[str],
    sorts: NotRequired[Sequence[SortTypeDef]],  # (3)
  1. See FieldIdentifierTypeDef
  2. See CaseFilterTypeDef
  3. See SortTypeDef

BasicLayoutTypeDef#

# BasicLayoutTypeDef definition

class BasicLayoutTypeDef(TypedDict):
    moreInfo: NotRequired[LayoutSectionsUnionTypeDef],  # (1)
    topPanel: NotRequired[LayoutSectionsUnionTypeDef],  # (1)
  1. See LayoutSectionsTypeDef LayoutSectionsOutputTypeDef
  2. See LayoutSectionsTypeDef LayoutSectionsOutputTypeDef

LayoutContentTypeDef#

# LayoutContentTypeDef definition

class LayoutContentTypeDef(TypedDict):
    basic: NotRequired[BasicLayoutUnionTypeDef],  # (1)
  1. See BasicLayoutTypeDef BasicLayoutOutputTypeDef

CreateLayoutRequestRequestTypeDef#

# CreateLayoutRequestRequestTypeDef definition

class CreateLayoutRequestRequestTypeDef(TypedDict):
    content: LayoutContentTypeDef,  # (1)
    domainId: str,
    name: str,
  1. See LayoutContentTypeDef

UpdateLayoutRequestRequestTypeDef#

# UpdateLayoutRequestRequestTypeDef definition

class UpdateLayoutRequestRequestTypeDef(TypedDict):
    domainId: str,
    layoutId: str,
    content: NotRequired[LayoutContentTypeDef],  # (1)
    name: NotRequired[str],
  1. See LayoutContentTypeDef