Skip to content

Type definitions#

Index > ConnectCases > Type definitions

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

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)
    description: NotRequired[str],
    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,

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

FieldValueUnionTypeDef#

# FieldValueUnionTypeDef definition

class FieldValueUnionTypeDef(TypedDict):
    booleanValue: NotRequired[bool],
    doubleValue: NotRequired[float],
    emptyValue: NotRequired[Mapping[str, Any]],
    stringValue: NotRequired[str],
    userArnValue: 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

CaseEventIncludedDataTypeDef#

# CaseEventIncludedDataTypeDef definition

class CaseEventIncludedDataTypeDef(TypedDict):
    fields: List[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):
    nextToken: str,
    options: List[FieldOptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  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)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CaseSummaryTypeDef
  2. See ResponseMetadataTypeDef

RelatedItemContentTypeDef#

# RelatedItemContentTypeDef definition

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

RelatedItemTypeFilterTypeDef#

# RelatedItemTypeFilterTypeDef definition

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

RelatedItemInputContentTypeDef#

# RelatedItemInputContentTypeDef definition

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

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):
    description: str,
    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