Skip to content

Type definitions#

Index > ConnectCases > Type definitions

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

FieldValueExtraUnionTypeDef#

# FieldValueExtraUnionTypeDef definition

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

EventBridgeConfigurationUnionTypeDef#

# EventBridgeConfigurationUnionTypeDef definition

EventBridgeConfigurationUnionTypeDef = Union[
    EventBridgeConfigurationTypeDef,  # (1)
    EventBridgeConfigurationOutputTypeDef,  # (2)
]
  1. See EventBridgeConfigurationTypeDef
  2. See EventBridgeConfigurationOutputTypeDef

LayoutContentUnionTypeDef#

# LayoutContentUnionTypeDef definition

LayoutContentUnionTypeDef = Union[
    LayoutContentTypeDef,  # (1)
    LayoutContentOutputTypeDef,  # (2)
]
  1. See LayoutContentTypeDef
  2. See LayoutContentOutputTypeDef

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

FieldValueUnionExtraOutputTypeDef#

# FieldValueUnionExtraOutputTypeDef definition

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

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: NotRe