Skip to content

ConnectCasesClient

Index > ConnectCases > ConnectCasesClient

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

ConnectCasesClient

Type annotations and code completion for boto3.client("connectcases"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_connectcases.client import ConnectCasesClient

def get_connectcases_client() -> ConnectCasesClient:
    return Session().client("connectcases")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("connectcases").exceptions structure.

Usage example
client = boto3.client("connectcases")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_connectcases.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

batch_get_field

Returns the description for the list of fields in the request parameters.

Type annotations and code completion for boto3.client("connectcases").batch_get_field method. boto3 documentation

Method definition
def batch_get_field(
    self,
    *,
    domainId: str,
    fields: Sequence[FieldIdentifierTypeDef],  # (1)
) -> BatchGetFieldResponseTypeDef:  # (2)
    ...
  1. See FieldIdentifierTypeDef
  2. See BatchGetFieldResponseTypeDef
Usage example with kwargs
kwargs: BatchGetFieldRequestRequestTypeDef = {  # (1)
    "domainId": ...,
    "fields": ...,
}

parent.batch_get_field(**kwargs)
  1. See BatchGetFieldRequestRequestTypeDef

batch_put_field_options

Creates and updates a set of field options for a single select field in a Cases domain.

Type annotations and code completion for boto3.client("connectcases").batch_put_field_options method. boto3 documentation

Method definition
def batch_put_field_options(
    self,
    *,
    domainId: str,
    fieldId: str,
    options: Sequence[FieldOptionTypeDef],  # (1)
) -> BatchPutFieldOptionsResponseTypeDef:  # (2)
    ...
  1. See FieldOptionTypeDef
  2. See BatchPutFieldOptionsResponseTypeDef
Usage example with kwargs
kwargs: BatchPutFieldOptionsRequestRequestTypeDef = {  # (1)
    "domainId": ...,
    "fieldId": ...,
    "options": ...,
}

parent.batch_put_field_options(**kwargs)
  1. See BatchPutFieldOptionsRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("connectcases").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("connectcases").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_case

Creates a case in the specified Cases domain.

Type annotations and code completion for boto3.client("connectcases").create_case method. boto3 documentation

Method definition
def create_case(
    self,
    *,
    domainId: str,
    fields: Sequence[FieldValueTypeDef],  # (1)
    templateId: str,
    clientToken: str = ...,
) -> CreateCaseResponseTypeDef:  # (2)
    ...
  1. See FieldValueTypeDef
  2. See CreateCaseResponseTypeDef
Usage example with kwargs
kwargs: CreateCaseRequestRequestTypeDef = {  # (1)
    "domainId": ...,
    "fields": ...,
    "templateId": ...,
}

parent.create_case(**kwargs)
  1. See CreateCaseRequestRequestTypeDef

create_domain

Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts.

Type annotations and code completion for boto3.client("connectcases").create_domain method. boto3 documentation

Method definition
def create_domain(
    self,
    *,
    name: str,
) -> CreateDomainResponseTypeDef:  # (1)
    ...
  1. See CreateDomainResponseTypeDef
Usage example with kwargs
kwargs: CreateDomainRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_domain(**kwargs)
  1. See CreateDomainRequestRequestTypeDef

create_field

Creates a field in the Cases domain.

Type annotations and code completion for boto3.client("connectcases").create_field method. boto3 documentation

Method definition
def create_field(
    self,
    *,
    domainId: str,
    name: str,
    type: FieldTypeType,  # (1)
    description: str = ...,
) -> CreateFieldResponseTypeDef:  # (2)
    ...
  1. See FieldTypeType
  2. See CreateFieldResponseTypeDef
Usage example with kwargs
kwargs: CreateFieldRequestRequestTypeDef = {  # (1)
    "domainId": ...,
    "name": ...,
    "type": ...,
}

parent.create_field(**kwargs)
  1. See CreateFieldRequestRequestTypeDef

create_layout

Creates a layout in the Cases domain.

Type annotations and code completion for boto3.client("connectcases").create_layout method. boto3 documentation

Method definition
def create_layout(
    self,
    *,
    content: LayoutContentTypeDef,  # (1)
    domainId: str,
    name: str,
) -> CreateLayoutResponseTypeDef:  # (2)
    ...
  1. See LayoutContentTypeDef
  2. See CreateLayoutResponseTypeDef
Usage example with kwargs
kwargs: CreateLayoutRequestRequestTypeDef = {  # (1)
    "content": ...,
    "domainId": ...,
    "name": ...,
}

parent.create_layout(**kwargs)
  1. See CreateLayoutRequestRequestTypeDef

Creates a related item (comments, tasks, and contacts) and associates it with a case.

Type annotations and code completion for boto3.client("connectcases").create_related_item method. boto3 documentation

Method definition
def create_related_item(
    self,
    *,
    caseId: str,
    content: RelatedItemInputContentTypeDef,  # (1)
    domainId: str,
    type: RelatedItemTypeType,  # (2)
) -> CreateRelatedItemResponseTypeDef:  # (3)
    ...
  1. See RelatedItemInputContentTypeDef
  2. See RelatedItemTypeType
  3. See CreateRelatedItemResponseTypeDef
Usage example with kwargs
kwargs: CreateRelatedItemRequestRequestTypeDef = {  # (1)
    "caseId": ...,
    "content": ...,
    "domainId": ...,
    "type": ...,
}

parent.create_related_item(**kwargs)
  1. See CreateRelatedItemRequestRequestTypeDef

create_template

Creates a template in the Cases domain.

Type annotations and code completion for boto3.client("connectcases").create_template method. boto3 documentation

Method definition
def create_template(
    self,
    *,
    domainId: str,
    name: str,
    description: str = ...,
    layoutConfiguration: LayoutConfigurationTypeDef = ...,  # (1)
    requiredFields: Sequence[RequiredFieldTypeDef] = ...,  # (2)
    status: TemplateStatusType = ...,  # (3)
) -> CreateTemplateResponseTypeDef:  # (4)
    ...
  1. See LayoutConfigurationTypeDef
  2. See RequiredFieldTypeDef
  3. See TemplateStatusType
  4. See CreateTemplateResponseTypeDef
Usage example with kwargs
kwargs: CreateTemplateRequestRequestTypeDef = {  # (1)
    "domainId": ...,
    "name": ...,
}

parent.create_template(**kwargs)
  1. See CreateTemplateRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("connectcases").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_case

Returns information about a specific case if it exists.

Type annotations and code completion for boto3.client("connectcases").get_case method. boto3 documentation

Method definition
def get_case(
    self,
    *,
    caseId: str,
    domainId: str,
    fields: Sequence[FieldIdentifierTypeDef],  # (1)
    nextToken: str = ...,
) -> GetCaseResponseTypeDef:  # (2)
    ...
  1. See FieldIdentifierTypeDef
  2. See GetCaseResponseTypeDef
Usage example with kwargs
kwargs: GetCaseRequestRequestTypeDef = {  # (1)
    "caseId": ...,
    "domainId": ...,
    "fields": ...,
}

parent.get_case(**kwargs)
  1. See GetCaseRequestRequestTypeDef

get_case_event_configuration

Returns the case event publishing configuration.

Type annotations and code completion for boto3.client("connectcases").get_case_event_configuration method. boto3 documentation

Method definition
def get_case_event_configuration(
    self,
    *,
    domainId: str,
) -> GetCaseEventConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetCaseEventConfigurationResponseTypeDef
Usage example with kwargs
kwargs: GetCaseEventConfigurationRequestRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.get_case_event_configuration(**kwargs)
  1. See GetCaseEventConfigurationRequestRequestTypeDef

get_domain

Returns information about a specific domain if it exists.

Type annotations and code completion for boto3.client("connectcases").get_domain method. boto3 documentation

Method definition
def get_domain(
    self,
    *,
    domainId: str,
) -> GetDomainResponseTypeDef:  # (1)
    ...
  1. See GetDomainResponseTypeDef
Usage example with kwargs
kwargs: GetDomainRequestRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.get_domain(**kwargs)
  1. See GetDomainRequestRequestTypeDef

get_layout

Returns the details for the requested layout.

Type annotations and code completion for boto3.client("connectcases").get_layout method. boto3 documentation

Method definition
def get_layout(
    self,
    *,
    domainId: str,
    layoutId: str,
) -> GetLayoutResponseTypeDef:  # (1)
    ...
  1. See GetLayoutResponseTypeDef
Usage example with kwargs
kwargs: GetLayoutRequestRequestTypeDef = {  # (1)
    "domainId": ...,
    "layoutId": ...,
}

parent.get_layout(**kwargs)
  1. See GetLayoutRequestRequestTypeDef

get_template

Returns the details for the requested template.

Type annotations and code completion for boto3.client("connectcases").get_template method. boto3 documentation

Method definition
def get_template(
    self,
    *,
    domainId: str,
    templateId: str,
) -> GetTemplateResponseTypeDef:  # (1)
    ...
  1. See GetTemplateResponseTypeDef
Usage example with kwargs
kwargs: GetTemplateRequestRequestTypeDef = {  # (1)
    "domainId": ...,
    "templateId": ...,
}

parent.get_template(**kwargs)
  1. See GetTemplateRequestRequestTypeDef

list_cases_for_contact

Lists cases for a given contact.

Type annotations and code completion for boto3.client("connectcases").list_cases_for_contact method. boto3 documentation

Method definition
def list_cases_for_contact(
    self,
    *,
    contactArn: str,
    domainId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCasesForContactResponseTypeDef:  # (1)
    ...
  1. See ListCasesForContactResponseTypeDef
Usage example with kwargs
kwargs: ListCasesForContactRequestRequestTypeDef = {  # (1)
    "contactArn": ...,
    "domainId": ...,
}

parent.list_cases_for_contact(**kwargs)
  1. See ListCasesForContactRequestRequestTypeDef

list_domains

Lists all cases domains in the Amazon Web Services account.

Type annotations and code completion for boto3.client("connectcases").list_domains method. boto3 documentation

Method definition
def list_domains(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDomainsResponseTypeDef:  # (1)
    ...
  1. See ListDomainsResponseTypeDef
Usage example with kwargs
kwargs: ListDomainsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_domains(**kwargs)
  1. See ListDomainsRequestRequestTypeDef

list_field_options

Lists all of the field options for a field identifier in the domain.

Type annotations and code completion for boto3.client("connectcases").list_field_options method. boto3 documentation

Method definition
def list_field_options(
    self,
    *,
    domainId: str,
    fieldId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    values: Sequence[str] = ...,
) -> ListFieldOptionsResponseTypeDef:  # (1)
    ...
  1. See ListFieldOptionsResponseTypeDef
Usage example with kwargs
kwargs: ListFieldOptionsRequestRequestTypeDef = {  # (1)
    "domainId": ...,
    "fieldId": ...,
}

parent.list_field_options(**kwargs)
  1. See ListFieldOptionsRequestRequestTypeDef

list_fields

Lists all fields in a Cases domain.

Type annotations and code completion for boto3.client("connectcases").list_fields method. boto3 documentation

Method definition
def list_fields(
    self,
    *,
    domainId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListFieldsResponseTypeDef:  # (1)
    ...
  1. See ListFieldsResponseTypeDef
Usage example with kwargs
kwargs: ListFieldsRequestRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.list_fields(**kwargs)
  1. See ListFieldsRequestRequestTypeDef

list_layouts

Lists all layouts in the given cases domain.

Type annotations and code completion for boto3.client("connectcases").list_layouts method. boto3 documentation

Method definition
def list_layouts(
    self,
    *,
    domainId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListLayoutsResponseTypeDef:  # (1)
    ...
  1. See ListLayoutsResponseTypeDef
Usage example with kwargs
kwargs: ListLayoutsRequestRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.list_layouts(**kwargs)
  1. See ListLayoutsRequestRequestTypeDef

list_tags_for_resource

Lists tags for a resource.

Type annotations and code completion for boto3.client("connectcases").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    arn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_templates

Lists all of the templates in a Cases domain.

Type annotations and code completion for boto3.client("connectcases").list_templates method. boto3 documentation

Method definition
def list_templates(
    self,
    *,
    domainId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    status: Sequence[TemplateStatusType] = ...,  # (1)
) -> ListTemplatesResponseTypeDef:  # (2)
    ...
  1. See TemplateStatusType
  2. See ListTemplatesResponseTypeDef
Usage example with kwargs
kwargs: ListTemplatesRequestRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.list_templates(**kwargs)
  1. See ListTemplatesRequestRequestTypeDef

put_case_event_configuration

API for adding case event publishing configuration See also: AWS API Documentation.

Type annotations and code completion for boto3.client("connectcases").put_case_event_configuration method. boto3 documentation

Method definition
def put_case_event_configuration(
    self,
    *,
    domainId: str,
    eventBridge: EventBridgeConfigurationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See EventBridgeConfigurationTypeDef
Usage example with kwargs
kwargs: PutCaseEventConfigurationRequestRequestTypeDef = {  # (1)
    "domainId": ...,
    "eventBridge": ...,
}

parent.put_case_event_configuration(**kwargs)
  1. See PutCaseEventConfigurationRequestRequestTypeDef

search_cases

Searches for cases within their associated Cases domain.

Type annotations and code completion for boto3.client("connectcases").search_cases method. boto3 documentation

Method definition
def search_cases(
    self,
    *,
    domainId: str,
    fields: Sequence[FieldIdentifierTypeDef] = ...,  # (1)
    filter: CaseFilterTypeDef = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
    searchTerm: str = ...,
    sorts: Sequence[SortTypeDef] = ...,  # (3)
) -> SearchCasesResponseTypeDef:  # (4)
    ...
  1. See FieldIdentifierTypeDef
  2. See CaseFilterTypeDef
  3. See SortTypeDef
  4. See SearchCasesResponseTypeDef
Usage example with kwargs
kwargs: SearchCasesRequestRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.search_cases(**kwargs)
  1. See SearchCasesRequestRequestTypeDef

Searches for related items that are associated with a case.

Type annotations and code completion for boto3.client("connectcases").search_related_items method. boto3 documentation

Method definition
def search_related_items(
    self,
    *,
    caseId: str,
    domainId: str,
    filters: Sequence[RelatedItemTypeFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> SearchRelatedItemsResponseTypeDef:  # (2)
    ...
  1. See RelatedItemTypeFilterTypeDef
  2. See SearchRelatedItemsResponseTypeDef
Usage example with kwargs
kwargs: SearchRelatedItemsRequestRequestTypeDef = {  # (1)
    "caseId": ...,
    "domainId": ...,
}

parent.search_related_items(**kwargs)
  1. See SearchRelatedItemsRequestRequestTypeDef

tag_resource

Adds tags to a resource.

Type annotations and code completion for boto3.client("connectcases").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    arn: str,
    tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Untags a resource.

Type annotations and code completion for boto3.client("connectcases").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    arn: str,
    tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_case

Updates the values of fields on a case.

Type annotations and code completion for boto3.client("connectcases").update_case method. boto3 documentation

Method definition
def update_case(
    self,
    *,
    caseId: str,
    domainId: str,
    fields: Sequence[FieldValueTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See FieldValueTypeDef
Usage example with kwargs
kwargs: UpdateCaseRequestRequestTypeDef = {  # (1)
    "caseId": ...,
    "domainId": ...,
    "fields": ...,
}

parent.update_case(**kwargs)
  1. See UpdateCaseRequestRequestTypeDef

update_field

Updates the properties of an existing field.

Type annotations and code completion for boto3.client("connectcases").update_field method. boto3 documentation

Method definition
def update_field(
    self,
    *,
    domainId: str,
    fieldId: str,
    description: str = ...,
    name: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateFieldRequestRequestTypeDef = {  # (1)
    "domainId": ...,
    "fieldId": ...,
}

parent.update_field(**kwargs)
  1. See UpdateFieldRequestRequestTypeDef

update_layout

Updates the attributes of an existing layout.

Type annotations and code completion for boto3.client("connectcases").update_layout method. boto3 documentation

Method definition
def update_layout(
    self,
    *,
    domainId: str,
    layoutId: str,
    content: LayoutContentTypeDef = ...,  # (1)
    name: str = ...,
) -> Dict[str, Any]:
    ...
  1. See LayoutContentTypeDef
Usage example with kwargs
kwargs: UpdateLayoutRequestRequestTypeDef = {  # (1)
    "domainId": ...,
    "layoutId": ...,
}

parent.update_layout(**kwargs)
  1. See UpdateLayoutRequestRequestTypeDef

update_template

Updates the attributes of an existing template.

Type annotations and code completion for boto3.client("connectcases").update_template method. boto3 documentation

Method definition
def update_template(
    self,
    *,
    domainId: str,
    templateId: str,
    description: str = ...,
    layoutConfiguration: LayoutConfigurationTypeDef = ...,  # (1)
    name: str = ...,
    requiredFields: Sequence[RequiredFieldTypeDef] = ...,  # (2)
    status: TemplateStatusType = ...,  # (3)
) -> Dict[str, Any]:
    ...
  1. See LayoutConfigurationTypeDef
  2. See RequiredFieldTypeDef
  3. See TemplateStatusType
Usage example with kwargs
kwargs: UpdateTemplateRequestRequestTypeDef = {  # (1)
    "domainId": ...,
    "templateId": ...,
}

parent.update_template(**kwargs)
  1. See UpdateTemplateRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("connectcases").get_paginator method with overloads.