Typed dictionaries
Index > ConnectCases > Typed dictionaries
Auto-generated documentation for ConnectCases type annotations stubs module mypy-boto3-connectcases.
FieldIdentifierTypeDef
# FieldIdentifierTypeDef usage example
from mypy_boto3_connectcases.type_defs import FieldIdentifierTypeDef
def get_value() -> FieldIdentifierTypeDef:
return {
"id": ...,
}
# FieldIdentifierTypeDef definition
class FieldIdentifierTypeDef(TypedDict):
id: str,
FieldErrorTypeDef
# FieldErrorTypeDef usage example
from mypy_boto3_connectcases.type_defs import FieldErrorTypeDef
def get_value() -> FieldErrorTypeDef:
return {
"errorCode": ...,
"id": ...,
}
# FieldErrorTypeDef definition
class FieldErrorTypeDef(TypedDict):
errorCode: str,
id: str,
message: NotRequired[str],
GetFieldResponseTypeDef
# GetFieldResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import GetFieldResponseTypeDef
def get_value() -> GetFieldResponseTypeDef:
return {
"fieldArn": ...,
"fieldId": ...,
"name": ...,
"namespace": ...,
"type": ...,
}
# 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]],
- See FieldNamespaceType
- See FieldTypeType
ResponseMetadataTypeDef
# ResponseMetadataTypeDef usage example
from mypy_boto3_connectcases.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
FieldOptionTypeDef
# FieldOptionTypeDef usage example
from mypy_boto3_connectcases.type_defs import FieldOptionTypeDef
def get_value() -> FieldOptionTypeDef:
return {
"active": ...,
"name": ...,
"value": ...,
}
# FieldOptionTypeDef definition
class FieldOptionTypeDef(TypedDict):
active: bool,
name: str,
value: str,
FieldOptionErrorTypeDef
# FieldOptionErrorTypeDef usage example
from mypy_boto3_connectcases.type_defs import FieldOptionErrorTypeDef
def get_value() -> FieldOptionErrorTypeDef:
return {
"errorCode": ...,
"message": ...,
"value": ...,
}
# FieldOptionErrorTypeDef definition
class FieldOptionErrorTypeDef(TypedDict):
errorCode: str,
message: str,
value: str,
CaseSummaryTypeDef
# CaseSummaryTypeDef usage example
from mypy_boto3_connectcases.type_defs import CaseSummaryTypeDef
def get_value() -> CaseSummaryTypeDef:
return {
"caseId": ...,
"templateId": ...,
}
# CaseSummaryTypeDef definition
class CaseSummaryTypeDef(TypedDict):
caseId: str,
templateId: str,
CommentContentTypeDef
# CommentContentTypeDef usage example
from mypy_boto3_connectcases.type_defs import CommentContentTypeDef
def get_value() -> CommentContentTypeDef:
return {
"body": ...,
"contentType": ...,
}
# CommentContentTypeDef definition
class CommentContentTypeDef(TypedDict):
body: str,
contentType: CommentBodyTextTypeType, # (1)
ContactContentTypeDef
# ContactContentTypeDef usage example
from mypy_boto3_connectcases.type_defs import ContactContentTypeDef
def get_value() -> ContactContentTypeDef:
return {
"channel": ...,
"connectedToSystemTime": ...,
"contactArn": ...,
}
# ContactContentTypeDef definition
class ContactContentTypeDef(TypedDict):
channel: str,
connectedToSystemTime: datetime,
contactArn: str,
ContactFilterTypeDef
# ContactFilterTypeDef usage example
from mypy_boto3_connectcases.type_defs import ContactFilterTypeDef
def get_value() -> ContactFilterTypeDef:
return {
"channel": ...,
}
# ContactFilterTypeDef definition
class ContactFilterTypeDef(TypedDict):
channel: NotRequired[Sequence[str]],
contactArn: NotRequired[str],
ContactTypeDef
# ContactTypeDef usage example
from mypy_boto3_connectcases.type_defs import ContactTypeDef
def get_value() -> ContactTypeDef:
return {
"contactArn": ...,
}
# ContactTypeDef definition
class ContactTypeDef(TypedDict):
contactArn: str,
CreateDomainRequestRequestTypeDef
# CreateDomainRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import CreateDomainRequestRequestTypeDef
def get_value() -> CreateDomainRequestRequestTypeDef:
return {
"name": ...,
}
# CreateDomainRequestRequestTypeDef definition
class CreateDomainRequestRequestTypeDef(TypedDict):
name: str,
CreateFieldRequestRequestTypeDef
# CreateFieldRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import CreateFieldRequestRequestTypeDef
def get_value() -> CreateFieldRequestRequestTypeDef:
return {
"domainId": ...,
"name": ...,
"type": ...,
}
# CreateFieldRequestRequestTypeDef definition
class CreateFieldRequestRequestTypeDef(TypedDict):
domainId: str,
name: str,
type: FieldTypeType, # (1)
description: NotRequired[str],
- See FieldTypeType
LayoutConfigurationTypeDef
# LayoutConfigurationTypeDef usage example
from mypy_boto3_connectcases.type_defs import LayoutConfigurationTypeDef
def get_value() -> LayoutConfigurationTypeDef:
return {
"defaultLayout": ...,
}
# LayoutConfigurationTypeDef definition
class LayoutConfigurationTypeDef(TypedDict):
defaultLayout: NotRequired[str],
RequiredFieldTypeDef
# RequiredFieldTypeDef usage example
from mypy_boto3_connectcases.type_defs import RequiredFieldTypeDef
def get_value() -> RequiredFieldTypeDef:
return {
"fieldId": ...,
}
# RequiredFieldTypeDef definition
class RequiredFieldTypeDef(TypedDict):
fieldId: str,
DeleteDomainRequestRequestTypeDef
# DeleteDomainRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import DeleteDomainRequestRequestTypeDef
def get_value() -> DeleteDomainRequestRequestTypeDef:
return {
"domainId": ...,
}
# DeleteDomainRequestRequestTypeDef definition
class DeleteDomainRequestRequestTypeDef(TypedDict):
domainId: str,
DomainSummaryTypeDef
# DomainSummaryTypeDef usage example
from mypy_boto3_connectcases.type_defs import DomainSummaryTypeDef
def get_value() -> DomainSummaryTypeDef:
return {
"domainArn": ...,
"domainId": ...,
"name": ...,
}
# DomainSummaryTypeDef definition
class DomainSummaryTypeDef(TypedDict):
domainArn: str,
domainId: str,
name: str,
RelatedItemEventIncludedDataTypeDef
# RelatedItemEventIncludedDataTypeDef usage example
from mypy_boto3_connectcases.type_defs import RelatedItemEventIncludedDataTypeDef
def get_value() -> RelatedItemEventIncludedDataTypeDef:
return {
"includeContent": ...,
}
# RelatedItemEventIncludedDataTypeDef definition
class RelatedItemEventIncludedDataTypeDef(TypedDict):
includeContent: bool,
FieldItemTypeDef
# FieldItemTypeDef usage example
from mypy_boto3_connectcases.type_defs import FieldItemTypeDef
def get_value() -> FieldItemTypeDef:
return {
"id": ...,
}
# FieldItemTypeDef definition
class FieldItemTypeDef(TypedDict):
id: str,
FieldSummaryTypeDef
# FieldSummaryTypeDef usage example
from mypy_boto3_connectcases.type_defs import FieldSummaryTypeDef
def get_value() -> FieldSummaryTypeDef:
return {
"fieldArn": ...,
"fieldId": ...,
"name": ...,
"namespace": ...,
"type": ...,
}
# FieldSummaryTypeDef definition
class FieldSummaryTypeDef(TypedDict):
fieldArn: str,
fieldId: str,
name: str,
namespace: FieldNamespaceType, # (1)
type: FieldTypeType, # (2)
- See FieldNamespaceType
- See FieldTypeType
FieldValueUnionTypeDef
# FieldValueUnionTypeDef usage example
from mypy_boto3_connectcases.type_defs import FieldValueUnionTypeDef
def get_value() -> FieldValueUnionTypeDef:
return {
"booleanValue": ...,
}
# FieldValueUnionTypeDef definition
class FieldValueUnionTypeDef(TypedDict):
booleanValue: NotRequired[bool],
doubleValue: NotRequired[float],
stringValue: NotRequired[str],
GetCaseEventConfigurationRequestRequestTypeDef
# GetCaseEventConfigurationRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import GetCaseEventConfigurationRequestRequestTypeDef
def get_value() -> GetCaseEventConfigurationRequestRequestTypeDef:
return {
"domainId": ...,
}
# GetCaseEventConfigurationRequestRequestTypeDef definition
class GetCaseEventConfigurationRequestRequestTypeDef(TypedDict):
domainId: str,
GetDomainRequestRequestTypeDef
# GetDomainRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import GetDomainRequestRequestTypeDef
def get_value() -> GetDomainRequestRequestTypeDef:
return {
"domainId": ...,
}
# GetDomainRequestRequestTypeDef definition
class GetDomainRequestRequestTypeDef(TypedDict):
domainId: str,
GetLayoutRequestRequestTypeDef
# GetLayoutRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import GetLayoutRequestRequestTypeDef
def get_value() -> GetLayoutRequestRequestTypeDef:
return {
"domainId": ...,
"layoutId": ...,
}
# GetLayoutRequestRequestTypeDef definition
class GetLayoutRequestRequestTypeDef(TypedDict):
domainId: str,
layoutId: str,
GetTemplateRequestRequestTypeDef
# GetTemplateRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import GetTemplateRequestRequestTypeDef
def get_value() -> GetTemplateRequestRequestTypeDef:
return {
"domainId": ...,
"templateId": ...,
}
# GetTemplateRequestRequestTypeDef definition
class GetTemplateRequestRequestTypeDef(TypedDict):
domainId: str,
templateId: str,
LayoutSummaryTypeDef
# LayoutSummaryTypeDef usage example
from mypy_boto3_connectcases.type_defs import LayoutSummaryTypeDef
def get_value() -> LayoutSummaryTypeDef:
return {
"layoutArn": ...,
"layoutId": ...,
"name": ...,
}
# LayoutSummaryTypeDef definition
class LayoutSummaryTypeDef(TypedDict):
layoutArn: str,
layoutId: str,
name: str,
ListCasesForContactRequestRequestTypeDef
# ListCasesForContactRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListCasesForContactRequestRequestTypeDef
def get_value() -> ListCasesForContactRequestRequestTypeDef:
return {
"contactArn": ...,
"domainId": ...,
}
# ListCasesForContactRequestRequestTypeDef definition
class ListCasesForContactRequestRequestTypeDef(TypedDict):
contactArn: str,
domainId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListDomainsRequestRequestTypeDef
# ListDomainsRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListDomainsRequestRequestTypeDef
def get_value() -> ListDomainsRequestRequestTypeDef:
return {
"maxResults": ...,
}
# ListDomainsRequestRequestTypeDef definition
class ListDomainsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListFieldOptionsRequestRequestTypeDef
# ListFieldOptionsRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListFieldOptionsRequestRequestTypeDef
def get_value() -> ListFieldOptionsRequestRequestTypeDef:
return {
"domainId": ...,
"fieldId": ...,
}
# ListFieldOptionsRequestRequestTypeDef definition
class ListFieldOptionsRequestRequestTypeDef(TypedDict):
domainId: str,
fieldId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
values: NotRequired[Sequence[str]],
ListFieldsRequestRequestTypeDef
# ListFieldsRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListFieldsRequestRequestTypeDef
def get_value() -> ListFieldsRequestRequestTypeDef:
return {
"domainId": ...,
}
# ListFieldsRequestRequestTypeDef definition
class ListFieldsRequestRequestTypeDef(TypedDict):
domainId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListLayoutsRequestRequestTypeDef
# ListLayoutsRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListLayoutsRequestRequestTypeDef
def get_value() -> ListLayoutsRequestRequestTypeDef:
return {
"domainId": ...,
}
# ListLayoutsRequestRequestTypeDef definition
class ListLayoutsRequestRequestTypeDef(TypedDict):
domainId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"arn": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
arn: str,
ListTemplatesRequestRequestTypeDef
# ListTemplatesRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListTemplatesRequestRequestTypeDef
def get_value() -> ListTemplatesRequestRequestTypeDef:
return {
"domainId": ...,
}
# ListTemplatesRequestRequestTypeDef definition
class ListTemplatesRequestRequestTypeDef(TypedDict):
domainId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
status: NotRequired[Sequence[TemplateStatusType]], # (1)
TemplateSummaryTypeDef
# TemplateSummaryTypeDef usage example
from mypy_boto3_connectcases.type_defs import TemplateSummaryTypeDef
def get_value() -> TemplateSummaryTypeDef:
return {
"name": ...,
"status": ...,
"templateArn": ...,
"templateId": ...,
}
# TemplateSummaryTypeDef definition
class TemplateSummaryTypeDef(TypedDict):
name: str,
status: TemplateStatusType, # (1)
templateArn: str,
templateId: str,
PaginatorConfigTypeDef
# PaginatorConfigTypeDef usage example
from mypy_boto3_connectcases.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
SortTypeDef
# SortTypeDef usage example
from mypy_boto3_connectcases.type_defs import SortTypeDef
def get_value() -> SortTypeDef:
return {
"fieldId": ...,
"sortOrder": ...,
}
# SortTypeDef definition
class SortTypeDef(TypedDict):
fieldId: str,
sortOrder: OrderType, # (1)
- See OrderType
TagResourceRequestRequestTypeDef
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"arn": ...,
"tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
arn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"arn": ...,
"tagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
arn: str,
tagKeys: Sequence[str],
UpdateFieldRequestRequestTypeDef
# UpdateFieldRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import UpdateFieldRequestRequestTypeDef
def get_value() -> UpdateFieldRequestRequestTypeDef:
return {
"domainId": ...,
"fieldId": ...,
}
# UpdateFieldRequestRequestTypeDef definition
class UpdateFieldRequestRequestTypeDef(TypedDict):
domainId: str,
fieldId: str,
description: NotRequired[str],
name: NotRequired[str],
BatchGetFieldRequestRequestTypeDef
# BatchGetFieldRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import BatchGetFieldRequestRequestTypeDef
def get_value() -> BatchGetFieldRequestRequestTypeDef:
return {
"domainId": ...,
"fields": ...,
}
# BatchGetFieldRequestRequestTypeDef definition
class BatchGetFieldRequestRequestTypeDef(TypedDict):
domainId: str,
fields: Sequence[FieldIdentifierTypeDef], # (1)
CaseEventIncludedDataTypeDef
# CaseEventIncludedDataTypeDef usage example
from mypy_boto3_connectcases.type_defs import CaseEventIncludedDataTypeDef
def get_value() -> CaseEventIncludedDataTypeDef:
return {
"fields": ...,
}
# CaseEventIncludedDataTypeDef definition
class CaseEventIncludedDataTypeDef(TypedDict):
fields: List[FieldIdentifierTypeDef], # (1)
GetCaseRequestRequestTypeDef
# GetCaseRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import GetCaseRequestRequestTypeDef
def get_value() -> GetCaseRequestRequestTypeDef:
return {
"caseId": ...,
"domainId": ...,
"fields": ...,
}
# GetCaseRequestRequestTypeDef definition
class GetCaseRequestRequestTypeDef(TypedDict):
caseId: str,
domainId: str,
fields: Sequence[FieldIdentifierTypeDef], # (1)
nextToken: NotRequired[str],
BatchGetFieldResponseTypeDef
# BatchGetFieldResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import BatchGetFieldResponseTypeDef
def get_value() -> BatchGetFieldResponseTypeDef:
return {
"errors": ...,
"fields": ...,
"ResponseMetadata": ...,
}
# BatchGetFieldResponseTypeDef definition
class BatchGetFieldResponseTypeDef(TypedDict):
errors: List[FieldErrorTypeDef], # (1)
fields: List[GetFieldResponseTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
CreateCaseResponseTypeDef
# CreateCaseResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import CreateCaseResponseTypeDef
def get_value() -> CreateCaseResponseTypeDef:
return {
"caseArn": ...,
"caseId": ...,
"ResponseMetadata": ...,
}
# CreateCaseResponseTypeDef definition
class CreateCaseResponseTypeDef(TypedDict):
caseArn: str,
caseId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDomainResponseTypeDef
# CreateDomainResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import CreateDomainResponseTypeDef
def get_value() -> CreateDomainResponseTypeDef:
return {
"domainArn": ...,
"domainId": ...,
"domainStatus": ...,
"ResponseMetadata": ...,
}
# CreateDomainResponseTypeDef definition
class CreateDomainResponseTypeDef(TypedDict):
domainArn: str,
domainId: str,
domainStatus: DomainStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateFieldResponseTypeDef
# CreateFieldResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import CreateFieldResponseTypeDef
def get_value() -> CreateFieldResponseTypeDef:
return {
"fieldArn": ...,
"fieldId": ...,
"ResponseMetadata": ...,
}
# CreateFieldResponseTypeDef definition
class CreateFieldResponseTypeDef(TypedDict):
fieldArn: str,
fieldId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateLayoutResponseTypeDef
# CreateLayoutResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import CreateLayoutResponseTypeDef
def get_value() -> CreateLayoutResponseTypeDef:
return {
"layoutArn": ...,
"layoutId": ...,
"ResponseMetadata": ...,
}
# CreateLayoutResponseTypeDef definition
class CreateLayoutResponseTypeDef(TypedDict):
layoutArn: str,
layoutId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateRelatedItemResponseTypeDef
# CreateRelatedItemResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import CreateRelatedItemResponseTypeDef
def get_value() -> CreateRelatedItemResponseTypeDef:
return {
"relatedItemArn": ...,
"relatedItemId": ...,
"ResponseMetadata": ...,
}
# CreateRelatedItemResponseTypeDef definition
class CreateRelatedItemResponseTypeDef(TypedDict):
relatedItemArn: str,
relatedItemId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTemplateResponseTypeDef
# CreateTemplateResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import CreateTemplateResponseTypeDef
def get_value() -> CreateTemplateResponseTypeDef:
return {
"templateArn": ...,
"templateId": ...,
"ResponseMetadata": ...,
}
# CreateTemplateResponseTypeDef definition
class CreateTemplateResponseTypeDef(TypedDict):
templateArn: str,
templateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef
# EmptyResponseMetadataTypeDef usage example
from mypy_boto3_connectcases.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetDomainResponseTypeDef
# GetDomainResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import GetDomainResponseTypeDef
def get_value() -> GetDomainResponseTypeDef:
return {
"createdTime": ...,
"domainArn": ...,
"domainId": ...,
"domainStatus": ...,
"name": ...,
"tags": ...,
"ResponseMetadata": ...,
}
# GetDomainResponseTypeDef definition
class GetDomainResponseTypeDef(TypedDict):
createdTime: datetime,
domainArn: str,
domainId: str,
domainStatus: DomainStatusType, # (1)
name: str,
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
BatchPutFieldOptionsRequestRequestTypeDef
# BatchPutFieldOptionsRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import BatchPutFieldOptionsRequestRequestTypeDef
def get_value() -> BatchPutFieldOptionsRequestRequestTypeDef:
return {
"domainId": ...,
"fieldId": ...,
"options": ...,
}
# BatchPutFieldOptionsRequestRequestTypeDef definition
class BatchPutFieldOptionsRequestRequestTypeDef(TypedDict):
domainId: str,
fieldId: str,
options: Sequence[FieldOptionTypeDef], # (1)
ListFieldOptionsResponseTypeDef
# ListFieldOptionsResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListFieldOptionsResponseTypeDef
def get_value() -> ListFieldOptionsResponseTypeDef:
return {
"nextToken": ...,
"options": ...,
"ResponseMetadata": ...,
}
# ListFieldOptionsResponseTypeDef definition
class ListFieldOptionsResponseTypeDef(TypedDict):
nextToken: str,
options: List[FieldOptionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchPutFieldOptionsResponseTypeDef
# BatchPutFieldOptionsResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import BatchPutFieldOptionsResponseTypeDef
def get_value() -> BatchPutFieldOptionsResponseTypeDef:
return {
"errors": ...,
"ResponseMetadata": ...,
}
# BatchPutFieldOptionsResponseTypeDef definition
class BatchPutFieldOptionsResponseTypeDef(TypedDict):
errors: List[FieldOptionErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListCasesForContactResponseTypeDef
# ListCasesForContactResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListCasesForContactResponseTypeDef
def get_value() -> ListCasesForContactResponseTypeDef:
return {
"cases": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListCasesForContactResponseTypeDef definition
class ListCasesForContactResponseTypeDef(TypedDict):
cases: List[CaseSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RelatedItemContentTypeDef
# RelatedItemContentTypeDef usage example
from mypy_boto3_connectcases.type_defs import RelatedItemContentTypeDef
def get_value() -> RelatedItemContentTypeDef:
return {
"comment": ...,
}
# RelatedItemContentTypeDef definition
class RelatedItemContentTypeDef(TypedDict):
comment: NotRequired[CommentContentTypeDef], # (1)
contact: NotRequired[ContactContentTypeDef], # (2)
RelatedItemTypeFilterTypeDef
# RelatedItemTypeFilterTypeDef usage example
from mypy_boto3_connectcases.type_defs import RelatedItemTypeFilterTypeDef
def get_value() -> RelatedItemTypeFilterTypeDef:
return {
"comment": ...,
}
# RelatedItemTypeFilterTypeDef definition
class RelatedItemTypeFilterTypeDef(TypedDict):
comment: NotRequired[Mapping[str, Any]],
contact: NotRequired[ContactFilterTypeDef], # (1)
RelatedItemInputContentTypeDef
# RelatedItemInputContentTypeDef usage example
from mypy_boto3_connectcases.type_defs import RelatedItemInputContentTypeDef
def get_value() -> RelatedItemInputContentTypeDef:
return {
"comment": ...,
}
# RelatedItemInputContentTypeDef definition
class RelatedItemInputContentTypeDef(TypedDict):
comment: NotRequired[CommentContentTypeDef], # (1)
contact: NotRequired[ContactTypeDef], # (2)
- See CommentContentTypeDef
- See ContactTypeDef
CreateTemplateRequestRequestTypeDef
# CreateTemplateRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import CreateTemplateRequestRequestTypeDef
def get_value() -> CreateTemplateRequestRequestTypeDef:
return {
"domainId": ...,
"name": ...,
}
# 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)
GetTemplateResponseTypeDef
# GetTemplateResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import GetTemplateResponseTypeDef
def get_value() -> GetTemplateResponseTypeDef:
return {
"description": ...,
"layoutConfiguration": ...,
"name": ...,
"requiredFields": ...,
"status": ...,
"tags": ...,
"templateArn": ...,
"templateId": ...,
"ResponseMetadata": ...,
}
# 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)
- See LayoutConfigurationTypeDef
- See RequiredFieldTypeDef
- See TemplateStatusType
- See ResponseMetadataTypeDef
UpdateTemplateRequestRequestTypeDef
# UpdateTemplateRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import UpdateTemplateRequestRequestTypeDef
def get_value() -> UpdateTemplateRequestRequestTypeDef:
return {
"domainId": ...,
"templateId": ...,
}
# 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)
ListDomainsResponseTypeDef
# ListDomainsResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListDomainsResponseTypeDef
def get_value() -> ListDomainsResponseTypeDef:
return {
"domains": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListDomainsResponseTypeDef definition
class ListDomainsResponseTypeDef(TypedDict):
domains: List[DomainSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
FieldGroupTypeDef
# FieldGroupTypeDef usage example
from mypy_boto3_connectcases.type_defs import FieldGroupTypeDef
def get_value() -> FieldGroupTypeDef:
return {
"fields": ...,
}
# FieldGroupTypeDef definition
class FieldGroupTypeDef(TypedDict):
fields: Sequence[FieldItemTypeDef], # (1)
name: NotRequired[str],
- See FieldItemTypeDef
ListFieldsResponseTypeDef
# ListFieldsResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListFieldsResponseTypeDef
def get_value() -> ListFieldsResponseTypeDef:
return {
"fields": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListFieldsResponseTypeDef definition
class ListFieldsResponseTypeDef(TypedDict):
fields: List[FieldSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
FieldValueTypeDef
# FieldValueTypeDef usage example
from mypy_boto3_connectcases.type_defs import FieldValueTypeDef
def get_value() -> FieldValueTypeDef:
return {
"id": ...,
"value": ...,
}
# FieldValueTypeDef definition
class FieldValueTypeDef(TypedDict):
id: str,
value: FieldValueUnionTypeDef, # (1)
ListLayoutsResponseTypeDef
# ListLayoutsResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListLayoutsResponseTypeDef
def get_value() -> ListLayoutsResponseTypeDef:
return {
"layouts": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListLayoutsResponseTypeDef definition
class ListLayoutsResponseTypeDef(TypedDict):
layouts: List[LayoutSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTemplatesResponseTypeDef
# ListTemplatesResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import ListTemplatesResponseTypeDef
def get_value() -> ListTemplatesResponseTypeDef:
return {
"nextToken": ...,
"templates": ...,
"ResponseMetadata": ...,
}
# ListTemplatesResponseTypeDef definition
class ListTemplatesResponseTypeDef(TypedDict):
nextToken: str,
templates: List[TemplateSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchCasesRequestRequestTypeDef
# SearchCasesRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import SearchCasesRequestRequestTypeDef
def get_value() -> SearchCasesRequestRequestTypeDef:
return {
"domainId": ...,
}
# 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)
- See FieldIdentifierTypeDef
- See CaseFilterTypeDef
- See SortTypeDef
SearchCasesRequestSearchCasesPaginateTypeDef
# SearchCasesRequestSearchCasesPaginateTypeDef usage example
from mypy_boto3_connectcases.type_defs import SearchCasesRequestSearchCasesPaginateTypeDef
def get_value() -> SearchCasesRequestSearchCasesPaginateTypeDef:
return {
"domainId": ...,
}
# SearchCasesRequestSearchCasesPaginateTypeDef definition
class SearchCasesRequestSearchCasesPaginateTypeDef(TypedDict):
domainId: str,
fields: NotRequired[Sequence[FieldIdentifierTypeDef]], # (1)
filter: NotRequired[CaseFilterTypeDef], # (2)
searchTerm: NotRequired[str],
sorts: NotRequired[Sequence[SortTypeDef]], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See FieldIdentifierTypeDef
- See CaseFilterTypeDef
- See SortTypeDef
- See PaginatorConfigTypeDef
EventIncludedDataTypeDef
# EventIncludedDataTypeDef usage example
from mypy_boto3_connectcases.type_defs import EventIncludedDataTypeDef
def get_value() -> EventIncludedDataTypeDef:
return {
"caseData": ...,
}
# EventIncludedDataTypeDef definition
class EventIncludedDataTypeDef(TypedDict):
caseData: NotRequired[CaseEventIncludedDataTypeDef], # (1)
relatedItemData: NotRequired[RelatedItemEventIncludedDataTypeDef], # (2)
SearchRelatedItemsResponseItemTypeDef
# SearchRelatedItemsResponseItemTypeDef usage example
from mypy_boto3_connectcases.type_defs import SearchRelatedItemsResponseItemTypeDef
def get_value() -> SearchRelatedItemsResponseItemTypeDef:
return {
"associationTime": ...,
"content": ...,
"relatedItemId": ...,
"type": ...,
}
# SearchRelatedItemsResponseItemTypeDef definition
class SearchRelatedItemsResponseItemTypeDef(TypedDict):
associationTime: datetime,
content: RelatedItemContentTypeDef, # (1)
relatedItemId: str,
type: RelatedItemTypeType, # (2)
tags: NotRequired[Dict[str, str]],
SearchRelatedItemsRequestRequestTypeDef
# SearchRelatedItemsRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import SearchRelatedItemsRequestRequestTypeDef
def get_value() -> SearchRelatedItemsRequestRequestTypeDef:
return {
"caseId": ...,
"domainId": ...,
}
# SearchRelatedItemsRequestRequestTypeDef definition
class SearchRelatedItemsRequestRequestTypeDef(TypedDict):
caseId: str,
domainId: str,
filters: NotRequired[Sequence[RelatedItemTypeFilterTypeDef]], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SearchRelatedItemsRequestSearchRelatedItemsPaginateTypeDef
# SearchRelatedItemsRequestSearchRelatedItemsPaginateTypeDef usage example
from mypy_boto3_connectcases.type_defs import SearchRelatedItemsRequestSearchRelatedItemsPaginateTypeDef
def get_value() -> SearchRelatedItemsRequestSearchRelatedItemsPaginateTypeDef:
return {
"caseId": ...,
"domainId": ...,
}
# SearchRelatedItemsRequestSearchRelatedItemsPaginateTypeDef definition
class SearchRelatedItemsRequestSearchRelatedItemsPaginateTypeDef(TypedDict):
caseId: str,
domainId: str,
filters: NotRequired[Sequence[RelatedItemTypeFilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
CreateRelatedItemRequestRequestTypeDef
# CreateRelatedItemRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import CreateRelatedItemRequestRequestTypeDef
def get_value() -> CreateRelatedItemRequestRequestTypeDef:
return {
"caseId": ...,
"content": ...,
"domainId": ...,
"type": ...,
}
# CreateRelatedItemRequestRequestTypeDef definition
class CreateRelatedItemRequestRequestTypeDef(TypedDict):
caseId: str,
content: RelatedItemInputContentTypeDef, # (1)
domainId: str,
type: RelatedItemTypeType, # (2)
SectionTypeDef
# SectionTypeDef usage example
from mypy_boto3_connectcases.type_defs import SectionTypeDef
def get_value() -> SectionTypeDef:
return {
"fieldGroup": ...,
}
# SectionTypeDef definition
class SectionTypeDef(TypedDict):
fieldGroup: NotRequired[FieldGroupTypeDef], # (1)
CreateCaseRequestRequestTypeDef
# CreateCaseRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import CreateCaseRequestRequestTypeDef
def get_value() -> CreateCaseRequestRequestTypeDef:
return {
"domainId": ...,
"fields": ...,
"templateId": ...,
}
# CreateCaseRequestRequestTypeDef definition
class CreateCaseRequestRequestTypeDef(TypedDict):
domainId: str,
fields: Sequence[FieldValueTypeDef], # (1)
templateId: str,
clientToken: NotRequired[str],
FieldFilterTypeDef
# FieldFilterTypeDef usage example
from mypy_boto3_connectcases.type_defs import FieldFilterTypeDef
def get_value() -> FieldFilterTypeDef:
return {
"contains": ...,
}
# FieldFilterTypeDef definition
class FieldFilterTypeDef(TypedDict):
contains: NotRequired[FieldValueTypeDef], # (1)
equalTo: NotRequired[FieldValueTypeDef], # (1)
greaterThan: NotRequired[FieldValueTypeDef], # (1)
greaterThanOrEqualTo: NotRequired[FieldValueTypeDef], # (1)
lessThan: NotRequired[FieldValueTypeDef], # (1)
lessThanOrEqualTo: NotRequired[FieldValueTypeDef], # (1)
- See FieldValueTypeDef
- See FieldValueTypeDef
- See FieldValueTypeDef
- See FieldValueTypeDef
- See FieldValueTypeDef
- See FieldValueTypeDef
GetCaseResponseTypeDef
# GetCaseResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import GetCaseResponseTypeDef
def get_value() -> GetCaseResponseTypeDef:
return {
"fields": ...,
"nextToken": ...,
"tags": ...,
"templateId": ...,
"ResponseMetadata": ...,
}
# GetCaseResponseTypeDef definition
class GetCaseResponseTypeDef(TypedDict):
fields: List[FieldValueTypeDef], # (1)
nextToken: str,
tags: Dict[str, str],
templateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchCasesResponseItemTypeDef
# SearchCasesResponseItemTypeDef usage example
from mypy_boto3_connectcases.type_defs import SearchCasesResponseItemTypeDef
def get_value() -> SearchCasesResponseItemTypeDef:
return {
"caseId": ...,
"fields": ...,
"templateId": ...,
}
# SearchCasesResponseItemTypeDef definition
class SearchCasesResponseItemTypeDef(TypedDict):
caseId: str,
fields: List[FieldValueTypeDef], # (1)
templateId: str,
tags: NotRequired[Dict[str, str]],
UpdateCaseRequestRequestTypeDef
# UpdateCaseRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import UpdateCaseRequestRequestTypeDef
def get_value() -> UpdateCaseRequestRequestTypeDef:
return {
"caseId": ...,
"domainId": ...,
"fields": ...,
}
# UpdateCaseRequestRequestTypeDef definition
class UpdateCaseRequestRequestTypeDef(TypedDict):
caseId: str,
domainId: str,
fields: Sequence[FieldValueTypeDef], # (1)
EventBridgeConfigurationTypeDef
# EventBridgeConfigurationTypeDef usage example
from mypy_boto3_connectcases.type_defs import EventBridgeConfigurationTypeDef
def get_value() -> EventBridgeConfigurationTypeDef:
return {
"enabled": ...,
}
# EventBridgeConfigurationTypeDef definition
class EventBridgeConfigurationTypeDef(TypedDict):
enabled: bool,
includedData: NotRequired[EventIncludedDataTypeDef], # (1)
SearchRelatedItemsResponseTypeDef
# SearchRelatedItemsResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import SearchRelatedItemsResponseTypeDef
def get_value() -> SearchRelatedItemsResponseTypeDef:
return {
"nextToken": ...,
"relatedItems": ...,
"ResponseMetadata": ...,
}
# SearchRelatedItemsResponseTypeDef definition
class SearchRelatedItemsResponseTypeDef(TypedDict):
nextToken: str,
relatedItems: List[SearchRelatedItemsResponseItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
LayoutSectionsTypeDef
# LayoutSectionsTypeDef usage example
from mypy_boto3_connectcases.type_defs import LayoutSectionsTypeDef
def get_value() -> LayoutSectionsTypeDef:
return {
"sections": ...,
}
# LayoutSectionsTypeDef definition
class LayoutSectionsTypeDef(TypedDict):
sections: NotRequired[Sequence[SectionTypeDef]], # (1)
- See SectionTypeDef
CaseFilterTypeDef
# CaseFilterTypeDef usage example
from mypy_boto3_connectcases.type_defs import CaseFilterTypeDef
def get_value() -> CaseFilterTypeDef:
return {
"andAll": ...,
}
# CaseFilterTypeDef definition
class CaseFilterTypeDef(TypedDict):
andAll: NotRequired[Sequence[CaseFilterTypeDef]], # (1)
field: NotRequired[FieldFilterTypeDef], # (2)
not: NotRequired[CaseFilterTypeDef], # (3)
- See CaseFilterTypeDef
- See FieldFilterTypeDef
- See CaseFilterTypeDef
SearchCasesResponseTypeDef
# SearchCasesResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import SearchCasesResponseTypeDef
def get_value() -> SearchCasesResponseTypeDef:
return {
"cases": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# SearchCasesResponseTypeDef definition
class SearchCasesResponseTypeDef(TypedDict):
cases: List[SearchCasesResponseItemTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetCaseEventConfigurationResponseTypeDef
# GetCaseEventConfigurationResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import GetCaseEventConfigurationResponseTypeDef
def get_value() -> GetCaseEventConfigurationResponseTypeDef:
return {
"eventBridge": ...,
"ResponseMetadata": ...,
}
# GetCaseEventConfigurationResponseTypeDef definition
class GetCaseEventConfigurationResponseTypeDef(TypedDict):
eventBridge: EventBridgeConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutCaseEventConfigurationRequestRequestTypeDef
# PutCaseEventConfigurationRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import PutCaseEventConfigurationRequestRequestTypeDef
def get_value() -> PutCaseEventConfigurationRequestRequestTypeDef:
return {
"domainId": ...,
"eventBridge": ...,
}
# PutCaseEventConfigurationRequestRequestTypeDef definition
class PutCaseEventConfigurationRequestRequestTypeDef(TypedDict):
domainId: str,
eventBridge: EventBridgeConfigurationTypeDef, # (1)
BasicLayoutTypeDef
# BasicLayoutTypeDef usage example
from mypy_boto3_connectcases.type_defs import BasicLayoutTypeDef
def get_value() -> BasicLayoutTypeDef:
return {
"moreInfo": ...,
}
# BasicLayoutTypeDef definition
class BasicLayoutTypeDef(TypedDict):
moreInfo: NotRequired[LayoutSectionsTypeDef], # (1)
topPanel: NotRequired[LayoutSectionsTypeDef], # (1)
LayoutContentTypeDef
# LayoutContentTypeDef usage example
from mypy_boto3_connectcases.type_defs import LayoutContentTypeDef
def get_value() -> LayoutContentTypeDef:
return {
"basic": ...,
}
# LayoutContentTypeDef definition
class LayoutContentTypeDef(TypedDict):
basic: NotRequired[BasicLayoutTypeDef], # (1)
CreateLayoutRequestRequestTypeDef
# CreateLayoutRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import CreateLayoutRequestRequestTypeDef
def get_value() -> CreateLayoutRequestRequestTypeDef:
return {
"content": ...,
"domainId": ...,
"name": ...,
}
# CreateLayoutRequestRequestTypeDef definition
class CreateLayoutRequestRequestTypeDef(TypedDict):
content: LayoutContentTypeDef, # (1)
domainId: str,
name: str,
GetLayoutResponseTypeDef
# GetLayoutResponseTypeDef usage example
from mypy_boto3_connectcases.type_defs import GetLayoutResponseTypeDef
def get_value() -> GetLayoutResponseTypeDef:
return {
"content": ...,
"layoutArn": ...,
"layoutId": ...,
"name": ...,
"tags": ...,
"ResponseMetadata": ...,
}
# GetLayoutResponseTypeDef definition
class GetLayoutResponseTypeDef(TypedDict):
content: LayoutContentTypeDef, # (1)
layoutArn: str,
layoutId: str,
name: str,
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateLayoutRequestRequestTypeDef
# UpdateLayoutRequestRequestTypeDef usage example
from mypy_boto3_connectcases.type_defs import UpdateLayoutRequestRequestTypeDef
def get_value() -> UpdateLayoutRequestRequestTypeDef:
return {
"domainId": ...,
"layoutId": ...,
}
# UpdateLayoutRequestRequestTypeDef definition
class UpdateLayoutRequestRequestTypeDef(TypedDict):
domainId: str,
layoutId: str,
content: NotRequired[LayoutContentTypeDef], # (1)
name: NotRequired[str],