Typed dictionaries

Index > ConnectCases > Typed dictionaries

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

FieldIdentifierTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import FieldIdentifierTypeDef

def get_value() -> FieldIdentifierTypeDef:
    return {
        "id": ...,
    }

Definition

class FieldIdentifierTypeDef(TypedDict):
    id: str,

FieldErrorTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import FieldErrorTypeDef

def get_value() -> FieldErrorTypeDef:
    return {
        "errorCode": ...,
        "id": ...,
    }

Definition

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

GetFieldResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import GetFieldResponseTypeDef

def get_value() -> GetFieldResponseTypeDef:
    return {
        "fieldArn": ...,
        "fieldId": ...,
        "name": ...,
        "namespace": ...,
        "type": ...,
    }

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

Usage Example

from mypy_boto3_connectcases.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

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

FieldOptionTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import FieldOptionTypeDef

def get_value() -> FieldOptionTypeDef:
    return {
        "active": ...,
        "name": ...,
        "value": ...,
    }

Definition

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

FieldOptionErrorTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import FieldOptionErrorTypeDef

def get_value() -> FieldOptionErrorTypeDef:
    return {
        "errorCode": ...,
        "message": ...,
        "value": ...,
    }

Definition

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

CaseSummaryTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CaseSummaryTypeDef

def get_value() -> CaseSummaryTypeDef:
    return {
        "caseId": ...,
        "templateId": ...,
    }

Definition

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

CommentContentTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CommentContentTypeDef

def get_value() -> CommentContentTypeDef:
    return {
        "body": ...,
        "contentType": ...,
    }

Definition

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

1. See CommentBodyTextTypeType

ContactContentTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ContactContentTypeDef

def get_value() -> ContactContentTypeDef:
    return {
        "channel": ...,
        "connectedToSystemTime": ...,
        "contactArn": ...,
    }

Definition

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

ContactFilterTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ContactFilterTypeDef

def get_value() -> ContactFilterTypeDef:
    return {
        "channel": ...,
    }

Definition

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

ContactTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ContactTypeDef

def get_value() -> ContactTypeDef:
    return {
        "contactArn": ...,
    }

Definition

class ContactTypeDef(TypedDict):
    contactArn: str,

CreateDomainRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CreateDomainRequestRequestTypeDef

def get_value() -> CreateDomainRequestRequestTypeDef:
    return {
        "name": ...,
    }

Definition

class CreateDomainRequestRequestTypeDef(TypedDict):
    name: str,

CreateFieldRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CreateFieldRequestRequestTypeDef

def get_value() -> CreateFieldRequestRequestTypeDef:
    return {
        "domainId": ...,
        "name": ...,
        "type": ...,
    }

Definition

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

1. See FieldTypeType

LayoutConfigurationTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import LayoutConfigurationTypeDef

def get_value() -> LayoutConfigurationTypeDef:
    return {
        "defaultLayout": ...,
    }

Definition

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

RequiredFieldTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import RequiredFieldTypeDef

def get_value() -> RequiredFieldTypeDef:
    return {
        "fieldId": ...,
    }

Definition

class RequiredFieldTypeDef(TypedDict):
    fieldId: str,

DeleteDomainRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import DeleteDomainRequestRequestTypeDef

def get_value() -> DeleteDomainRequestRequestTypeDef:
    return {
        "domainId": ...,
    }

Definition

class DeleteDomainRequestRequestTypeDef(TypedDict):
    domainId: str,

DomainSummaryTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import DomainSummaryTypeDef

def get_value() -> DomainSummaryTypeDef:
    return {
        "domainArn": ...,
        "domainId": ...,
        "name": ...,
    }

Definition

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

RelatedItemEventIncludedDataTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import RelatedItemEventIncludedDataTypeDef

def get_value() -> RelatedItemEventIncludedDataTypeDef:
    return {
        "includeContent": ...,
    }

Definition

class RelatedItemEventIncludedDataTypeDef(TypedDict):
    includeContent: bool,

FieldItemTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import FieldItemTypeDef

def get_value() -> FieldItemTypeDef:
    return {
        "id": ...,
    }

Definition

class FieldItemTypeDef(TypedDict):
    id: str,

FieldSummaryTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import FieldSummaryTypeDef

def get_value() -> FieldSummaryTypeDef:
    return {
        "fieldArn": ...,
        "fieldId": ...,
        "name": ...,
        "namespace": ...,
        "type": ...,
    }

Definition

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

1. See FieldNamespaceType
2. See FieldTypeType

FieldValueUnionTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import FieldValueUnionTypeDef

def get_value() -> FieldValueUnionTypeDef:
    return {
        "booleanValue": ...,
    }

Definition

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

GetCaseEventConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import GetCaseEventConfigurationRequestRequestTypeDef

def get_value() -> GetCaseEventConfigurationRequestRequestTypeDef:
    return {
        "domainId": ...,
    }

Definition

class GetCaseEventConfigurationRequestRequestTypeDef(TypedDict):
    domainId: str,

GetDomainRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import GetDomainRequestRequestTypeDef

def get_value() -> GetDomainRequestRequestTypeDef:
    return {
        "domainId": ...,
    }

Definition

class GetDomainRequestRequestTypeDef(TypedDict):
    domainId: str,

GetLayoutRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import GetLayoutRequestRequestTypeDef

def get_value() -> GetLayoutRequestRequestTypeDef:
    return {
        "domainId": ...,
        "layoutId": ...,
    }

Definition

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

GetTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import GetTemplateRequestRequestTypeDef

def get_value() -> GetTemplateRequestRequestTypeDef:
    return {
        "domainId": ...,
        "templateId": ...,
    }

Definition

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

LayoutSummaryTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import LayoutSummaryTypeDef

def get_value() -> LayoutSummaryTypeDef:
    return {
        "layoutArn": ...,
        "layoutId": ...,
        "name": ...,
    }

Definition

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

ListCasesForContactRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ListCasesForContactRequestRequestTypeDef

def get_value() -> ListCasesForContactRequestRequestTypeDef:
    return {
        "contactArn": ...,
        "domainId": ...,
    }

Definition

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

ListDomainsRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ListDomainsRequestRequestTypeDef

def get_value() -> ListDomainsRequestRequestTypeDef:
    return {
        "maxResults": ...,
    }

Definition

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

ListFieldOptionsRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ListFieldOptionsRequestRequestTypeDef

def get_value() -> ListFieldOptionsRequestRequestTypeDef:
    return {
        "domainId": ...,
        "fieldId": ...,
    }

Definition

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

ListFieldsRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ListFieldsRequestRequestTypeDef

def get_value() -> ListFieldsRequestRequestTypeDef:
    return {
        "domainId": ...,
    }

Definition

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

ListLayoutsRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ListLayoutsRequestRequestTypeDef

def get_value() -> ListLayoutsRequestRequestTypeDef:
    return {
        "domainId": ...,
    }

Definition

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

ListTagsForResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "arn": ...,
    }

Definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    arn: str,

ListTemplatesRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ListTemplatesRequestRequestTypeDef

def get_value() -> ListTemplatesRequestRequestTypeDef:
    return {
        "domainId": ...,
    }

Definition

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

1. See TemplateStatusType

TemplateSummaryTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import TemplateSummaryTypeDef

def get_value() -> TemplateSummaryTypeDef:
    return {
        "name": ...,
        "status": ...,
        "templateArn": ...,
        "templateId": ...,
    }

Definition

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

1. See TemplateStatusType

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

Definition

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

SortTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import SortTypeDef

def get_value() -> SortTypeDef:
    return {
        "fieldId": ...,
        "sortOrder": ...,
    }

Definition

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

1. See OrderType

TagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "arn": ...,
        "tags": ...,
    }

Definition

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

UntagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "arn": ...,
        "tagKeys": ...,
    }

Definition

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

UpdateFieldRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import UpdateFieldRequestRequestTypeDef

def get_value() -> UpdateFieldRequestRequestTypeDef:
    return {
        "domainId": ...,
        "fieldId": ...,
    }

Definition

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

BatchGetFieldRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import BatchGetFieldRequestRequestTypeDef

def get_value() -> BatchGetFieldRequestRequestTypeDef:
    return {
        "domainId": ...,
        "fields": ...,
    }

Definition

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

1. See FieldIdentifierTypeDef

CaseEventIncludedDataTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CaseEventIncludedDataTypeDef

def get_value() -> CaseEventIncludedDataTypeDef:
    return {
        "fields": ...,
    }

Definition

class CaseEventIncludedDataTypeDef(TypedDict):
    fields: List[FieldIdentifierTypeDef],  # (1)

1. See FieldIdentifierTypeDef

GetCaseRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import GetCaseRequestRequestTypeDef

def get_value() -> GetCaseRequestRequestTypeDef:
    return {
        "caseId": ...,
        "domainId": ...,
        "fields": ...,
    }

Definition

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

1. See FieldIdentifierTypeDef

BatchGetFieldResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import BatchGetFieldResponseTypeDef

def get_value() -> BatchGetFieldResponseTypeDef:
    return {
        "errors": ...,
        "fields": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_connectcases.type_defs import CreateCaseResponseTypeDef

def get_value() -> CreateCaseResponseTypeDef:
    return {
        "caseArn": ...,
        "caseId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CreateDomainResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CreateDomainResponseTypeDef

def get_value() -> CreateDomainResponseTypeDef:
    return {
        "domainArn": ...,
        "domainId": ...,
        "domainStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See DomainStatusType
2. See ResponseMetadataTypeDef

CreateFieldResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CreateFieldResponseTypeDef

def get_value() -> CreateFieldResponseTypeDef:
    return {
        "fieldArn": ...,
        "fieldId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CreateLayoutResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CreateLayoutResponseTypeDef

def get_value() -> CreateLayoutResponseTypeDef:
    return {
        "layoutArn": ...,
        "layoutId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CreateRelatedItemResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CreateRelatedItemResponseTypeDef

def get_value() -> CreateRelatedItemResponseTypeDef:
    return {
        "relatedItemArn": ...,
        "relatedItemId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CreateTemplateResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CreateTemplateResponseTypeDef

def get_value() -> CreateTemplateResponseTypeDef:
    return {
        "templateArn": ...,
        "templateId": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

GetDomainResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import GetDomainResponseTypeDef

def get_value() -> GetDomainResponseTypeDef:
    return {
        "createdTime": ...,
        "domainArn": ...,
        "domainId": ...,
        "domainStatus": ...,
        "name": ...,
        "tags": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_connectcases.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

BatchPutFieldOptionsRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import BatchPutFieldOptionsRequestRequestTypeDef

def get_value() -> BatchPutFieldOptionsRequestRequestTypeDef:
    return {
        "domainId": ...,
        "fieldId": ...,
        "options": ...,
    }

Definition

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

1. See FieldOptionTypeDef

ListFieldOptionsResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ListFieldOptionsResponseTypeDef

def get_value() -> ListFieldOptionsResponseTypeDef:
    return {
        "nextToken": ...,
        "options": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListFieldOptionsResponseTypeDef(TypedDict):
    nextToken: str,
    options: List[FieldOptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See FieldOptionTypeDef
2. See ResponseMetadataTypeDef

BatchPutFieldOptionsResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import BatchPutFieldOptionsResponseTypeDef

def get_value() -> BatchPutFieldOptionsResponseTypeDef:
    return {
        "errors": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See FieldOptionErrorTypeDef
2. See ResponseMetadataTypeDef

ListCasesForContactResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ListCasesForContactResponseTypeDef

def get_value() -> ListCasesForContactResponseTypeDef:
    return {
        "cases": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListCasesForContactResponseTypeDef(TypedDict):
    cases: List[CaseSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CaseSummaryTypeDef
2. See ResponseMetadataTypeDef

RelatedItemContentTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import RelatedItemContentTypeDef

def get_value() -> RelatedItemContentTypeDef:
    return {
        "comment": ...,
    }

Definition

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

1. See CommentContentTypeDef
2. See ContactContentTypeDef

RelatedItemTypeFilterTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import RelatedItemTypeFilterTypeDef

def get_value() -> RelatedItemTypeFilterTypeDef:
    return {
        "comment": ...,
    }

Definition

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

1. See ContactFilterTypeDef

RelatedItemInputContentTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import RelatedItemInputContentTypeDef

def get_value() -> RelatedItemInputContentTypeDef:
    return {
        "comment": ...,
    }

Definition

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

1. See CommentContentTypeDef
2. See ContactTypeDef

CreateTemplateRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CreateTemplateRequestRequestTypeDef

def get_value() -> CreateTemplateRequestRequestTypeDef:
    return {
        "domainId": ...,
        "name": ...,
    }

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

Usage Example

from mypy_boto3_connectcases.type_defs import GetTemplateResponseTypeDef

def get_value() -> GetTemplateResponseTypeDef:
    return {
        "description": ...,
        "layoutConfiguration": ...,
        "name": ...,
        "requiredFields": ...,
        "status": ...,
        "tags": ...,
        "templateArn": ...,
        "templateId": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_connectcases.type_defs import UpdateTemplateRequestRequestTypeDef

def get_value() -> UpdateTemplateRequestRequestTypeDef:
    return {
        "domainId": ...,
        "templateId": ...,
    }

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

Usage Example

from mypy_boto3_connectcases.type_defs import ListDomainsResponseTypeDef

def get_value() -> ListDomainsResponseTypeDef:
    return {
        "domains": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListDomainsResponseTypeDef(TypedDict):
    domains: List[DomainSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DomainSummaryTypeDef
2. See ResponseMetadataTypeDef

FieldGroupTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import FieldGroupTypeDef

def get_value() -> FieldGroupTypeDef:
    return {
        "fields": ...,
    }

Definition

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

1. See FieldItemTypeDef

ListFieldsResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ListFieldsResponseTypeDef

def get_value() -> ListFieldsResponseTypeDef:
    return {
        "fields": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListFieldsResponseTypeDef(TypedDict):
    fields: List[FieldSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See FieldSummaryTypeDef
2. See ResponseMetadataTypeDef

FieldValueTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import FieldValueTypeDef

def get_value() -> FieldValueTypeDef:
    return {
        "id": ...,
        "value": ...,
    }

Definition

class FieldValueTypeDef(TypedDict):
    id: str,
    value: FieldValueUnionTypeDef,  # (1)

1. See FieldValueUnionTypeDef

ListLayoutsResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ListLayoutsResponseTypeDef

def get_value() -> ListLayoutsResponseTypeDef:
    return {
        "layouts": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListLayoutsResponseTypeDef(TypedDict):
    layouts: List[LayoutSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LayoutSummaryTypeDef
2. See ResponseMetadataTypeDef

ListTemplatesResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import ListTemplatesResponseTypeDef

def get_value() -> ListTemplatesResponseTypeDef:
    return {
        "nextToken": ...,
        "templates": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTemplatesResponseTypeDef(TypedDict):
    nextToken: str,
    templates: List[TemplateSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TemplateSummaryTypeDef
2. See ResponseMetadataTypeDef

SearchCasesRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import SearchCasesRequestRequestTypeDef

def get_value() -> SearchCasesRequestRequestTypeDef:
    return {
        "domainId": ...,
    }

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

SearchCasesRequestSearchCasesPaginateTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import SearchCasesRequestSearchCasesPaginateTypeDef

def get_value() -> SearchCasesRequestSearchCasesPaginateTypeDef:
    return {
        "domainId": ...,
    }

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)

1. See FieldIdentifierTypeDef
2. See CaseFilterTypeDef
3. See SortTypeDef
4. See PaginatorConfigTypeDef

EventIncludedDataTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import EventIncludedDataTypeDef

def get_value() -> EventIncludedDataTypeDef:
    return {
        "caseData": ...,
    }

Definition

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

1. See CaseEventIncludedDataTypeDef
2. See RelatedItemEventIncludedDataTypeDef

SearchRelatedItemsResponseItemTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import SearchRelatedItemsResponseItemTypeDef

def get_value() -> SearchRelatedItemsResponseItemTypeDef:
    return {
        "associationTime": ...,
        "content": ...,
        "relatedItemId": ...,
        "type": ...,
    }

Definition

class SearchRelatedItemsResponseItemTypeDef(TypedDict):
    associationTime: datetime,
    content: RelatedItemContentTypeDef,  # (1)
    relatedItemId: str,
    type: RelatedItemTypeType,  # (2)
    tags: NotRequired[Dict[str, str]],

1. See RelatedItemContentTypeDef
2. See RelatedItemTypeType

SearchRelatedItemsRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import SearchRelatedItemsRequestRequestTypeDef

def get_value() -> SearchRelatedItemsRequestRequestTypeDef:
    return {
        "caseId": ...,
        "domainId": ...,
    }

Definition

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

1. See RelatedItemTypeFilterTypeDef

SearchRelatedItemsRequestSearchRelatedItemsPaginateTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import SearchRelatedItemsRequestSearchRelatedItemsPaginateTypeDef

def get_value() -> SearchRelatedItemsRequestSearchRelatedItemsPaginateTypeDef:
    return {
        "caseId": ...,
        "domainId": ...,
    }

Definition

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

1. See RelatedItemTypeFilterTypeDef
2. See PaginatorConfigTypeDef

CreateRelatedItemRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CreateRelatedItemRequestRequestTypeDef

def get_value() -> CreateRelatedItemRequestRequestTypeDef:
    return {
        "caseId": ...,
        "content": ...,
        "domainId": ...,
        "type": ...,
    }

Definition

class CreateRelatedItemRequestRequestTypeDef(TypedDict):
    caseId: str,
    content: RelatedItemInputContentTypeDef,  # (1)
    domainId: str,
    type: RelatedItemTypeType,  # (2)

1. See RelatedItemInputContentTypeDef
2. See RelatedItemTypeType

SectionTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import SectionTypeDef

def get_value() -> SectionTypeDef:
    return {
        "fieldGroup": ...,
    }

Definition

class SectionTypeDef(TypedDict):
    fieldGroup: NotRequired[FieldGroupTypeDef],  # (1)

1. See FieldGroupTypeDef

CreateCaseRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CreateCaseRequestRequestTypeDef

def get_value() -> CreateCaseRequestRequestTypeDef:
    return {
        "domainId": ...,
        "fields": ...,
        "templateId": ...,
    }

Definition

class CreateCaseRequestRequestTypeDef(TypedDict):
    domainId: str,
    fields: Sequence[FieldValueTypeDef],  # (1)
    templateId: str,
    clientToken: NotRequired[str],

1. See FieldValueTypeDef

FieldFilterTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import FieldFilterTypeDef

def get_value() -> FieldFilterTypeDef:
    return {
        "contains": ...,
    }

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)

1. See FieldValueTypeDef
2. See FieldValueTypeDef
3. See FieldValueTypeDef
4. See FieldValueTypeDef
5. See FieldValueTypeDef
6. See FieldValueTypeDef

GetCaseResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import GetCaseResponseTypeDef

def get_value() -> GetCaseResponseTypeDef:
    return {
        "fields": ...,
        "nextToken": ...,
        "tags": ...,
        "templateId": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetCaseResponseTypeDef(TypedDict):
    fields: List[FieldValueTypeDef],  # (1)
    nextToken: str,
    tags: Dict[str, str],
    templateId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See FieldValueTypeDef
2. See ResponseMetadataTypeDef

SearchCasesResponseItemTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import SearchCasesResponseItemTypeDef

def get_value() -> SearchCasesResponseItemTypeDef:
    return {
        "caseId": ...,
        "fields": ...,
        "templateId": ...,
    }

Definition

class SearchCasesResponseItemTypeDef(TypedDict):
    caseId: str,
    fields: List[FieldValueTypeDef],  # (1)
    templateId: str,
    tags: NotRequired[Dict[str, str]],

1. See FieldValueTypeDef

UpdateCaseRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import UpdateCaseRequestRequestTypeDef

def get_value() -> UpdateCaseRequestRequestTypeDef:
    return {
        "caseId": ...,
        "domainId": ...,
        "fields": ...,
    }

Definition

class UpdateCaseRequestRequestTypeDef(TypedDict):
    caseId: str,
    domainId: str,
    fields: Sequence[FieldValueTypeDef],  # (1)

1. See FieldValueTypeDef

EventBridgeConfigurationTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import EventBridgeConfigurationTypeDef

def get_value() -> EventBridgeConfigurationTypeDef:
    return {
        "enabled": ...,
    }

Definition

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

1. See EventIncludedDataTypeDef

SearchRelatedItemsResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import SearchRelatedItemsResponseTypeDef

def get_value() -> SearchRelatedItemsResponseTypeDef:
    return {
        "nextToken": ...,
        "relatedItems": ...,
        "ResponseMetadata": ...,
    }

Definition

class SearchRelatedItemsResponseTypeDef(TypedDict):
    nextToken: str,
    relatedItems: List[SearchRelatedItemsResponseItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SearchRelatedItemsResponseItemTypeDef
2. See ResponseMetadataTypeDef

LayoutSectionsTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import LayoutSectionsTypeDef

def get_value() -> LayoutSectionsTypeDef:
    return {
        "sections": ...,
    }

Definition

class LayoutSectionsTypeDef(TypedDict):
    sections: NotRequired[Sequence[SectionTypeDef]],  # (1)

1. See SectionTypeDef

CaseFilterTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CaseFilterTypeDef

def get_value() -> CaseFilterTypeDef:
    return {
        "andAll": ...,
    }

Definition

class CaseFilterTypeDef(TypedDict):
    andAll: NotRequired[Sequence[CaseFilterTypeDef]],  # (1)
    field: NotRequired[FieldFilterTypeDef],  # (2)
    not: NotRequired[CaseFilterTypeDef],  # (3)

1. See CaseFilterTypeDef
2. See FieldFilterTypeDef
3. See CaseFilterTypeDef

SearchCasesResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import SearchCasesResponseTypeDef

def get_value() -> SearchCasesResponseTypeDef:
    return {
        "cases": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class SearchCasesResponseTypeDef(TypedDict):
    cases: List[SearchCasesResponseItemTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SearchCasesResponseItemTypeDef
2. See ResponseMetadataTypeDef

GetCaseEventConfigurationResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import GetCaseEventConfigurationResponseTypeDef

def get_value() -> GetCaseEventConfigurationResponseTypeDef:
    return {
        "eventBridge": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetCaseEventConfigurationResponseTypeDef(TypedDict):
    eventBridge: EventBridgeConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EventBridgeConfigurationTypeDef
2. See ResponseMetadataTypeDef

PutCaseEventConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import PutCaseEventConfigurationRequestRequestTypeDef

def get_value() -> PutCaseEventConfigurationRequestRequestTypeDef:
    return {
        "domainId": ...,
        "eventBridge": ...,
    }

Definition

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

1. See EventBridgeConfigurationTypeDef

BasicLayoutTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import BasicLayoutTypeDef

def get_value() -> BasicLayoutTypeDef:
    return {
        "moreInfo": ...,
    }

Definition

class BasicLayoutTypeDef(TypedDict):
    moreInfo: NotRequired[LayoutSectionsTypeDef],  # (1)
    topPanel: NotRequired[LayoutSectionsTypeDef],  # (1)

1. See LayoutSectionsTypeDef
2. See LayoutSectionsTypeDef

LayoutContentTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import LayoutContentTypeDef

def get_value() -> LayoutContentTypeDef:
    return {
        "basic": ...,
    }

Definition

class LayoutContentTypeDef(TypedDict):
    basic: NotRequired[BasicLayoutTypeDef],  # (1)

1. See BasicLayoutTypeDef

CreateLayoutRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import CreateLayoutRequestRequestTypeDef

def get_value() -> CreateLayoutRequestRequestTypeDef:
    return {
        "content": ...,
        "domainId": ...,
        "name": ...,
    }

Definition

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

1. See LayoutContentTypeDef

GetLayoutResponseTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import GetLayoutResponseTypeDef

def get_value() -> GetLayoutResponseTypeDef:
    return {
        "content": ...,
        "layoutArn": ...,
        "layoutId": ...,
        "name": ...,
        "tags": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetLayoutResponseTypeDef(TypedDict):
    content: LayoutContentTypeDef,  # (1)
    layoutArn: str,
    layoutId: str,
    name: str,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LayoutContentTypeDef
2. See ResponseMetadataTypeDef

UpdateLayoutRequestRequestTypeDef

Usage Example

from mypy_boto3_connectcases.type_defs import UpdateLayoutRequestRequestTypeDef

def get_value() -> UpdateLayoutRequestRequestTypeDef:
    return {
        "domainId": ...,
        "layoutId": ...,
    }

Definition

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

1. See LayoutContentTypeDef