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

# ConnectCasesClient 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.

# Exceptions.exceptions usage example

client = boto3.client("connectcases")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_connectcases.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

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

# generate_presigned_url method definition

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

batch_get_case_rule

Gets a batch of case rules.

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

# batch_get_case_rule method definition

def batch_get_case_rule(
    self,
    *,
    caseRules: Sequence[CaseRuleIdentifierTypeDef],  # (1)
    domainId: str,
) -> BatchGetCaseRuleResponseTypeDef:  # (2)
    ...

1. See Sequence[CaseRuleIdentifierTypeDef]
2. See BatchGetCaseRuleResponseTypeDef

# batch_get_case_rule method usage example with argument unpacking

kwargs: BatchGetCaseRuleRequestTypeDef = {  # (1)
    "caseRules": ...,
    "domainId": ...,
}

parent.batch_get_case_rule(**kwargs)

1. See BatchGetCaseRuleRequestTypeDef

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

# batch_get_field method definition

def batch_get_field(
    self,
    *,
    domainId: str,
    fields: Sequence[FieldIdentifierTypeDef],  # (1)
) -> BatchGetFieldResponseTypeDef:  # (2)
    ...

1. See Sequence[FieldIdentifierTypeDef]
2. See BatchGetFieldResponseTypeDef

# batch_get_field method usage example with argument unpacking

kwargs: BatchGetFieldRequestTypeDef = {  # (1)
    "domainId": ...,
    "fields": ...,
}

parent.batch_get_field(**kwargs)

1. See BatchGetFieldRequestTypeDef

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

# batch_put_field_options method definition

def batch_put_field_options(
    self,
    *,
    domainId: str,
    fieldId: str,
    options: Sequence[FieldOptionTypeDef],  # (1)
) -> BatchPutFieldOptionsResponseTypeDef:  # (2)
    ...

1. See Sequence[FieldOptionTypeDef]
2. See BatchPutFieldOptionsResponseTypeDef

# batch_put_field_options method usage example with argument unpacking

kwargs: BatchPutFieldOptionsRequestTypeDef = {  # (1)
    "domainId": ...,
    "fieldId": ...,
    "options": ...,
}

parent.batch_put_field_options(**kwargs)

1. See BatchPutFieldOptionsRequestTypeDef

create_case

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide.

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

# create_case method definition

def create_case(
    self,
    *,
    domainId: str,
    fields: Sequence[FieldValueUnionExtraTypeDef],  # (1)
    templateId: str,
    clientToken: str = ...,
    performedBy: UserUnionTypeDef = ...,  # (2)
) -> CreateCaseResponseTypeDef:  # (3)
    ...

1. See Sequence[FieldValueUnionExtraTypeDef]
2. See UserUnionTypeDef
3. See CreateCaseResponseTypeDef

# create_case method usage example with argument unpacking

kwargs: CreateCaseRequestTypeDef = {  # (1)
    "domainId": ...,
    "fields": ...,
    "templateId": ...,
}

parent.create_case(**kwargs)

1. See CreateCaseRequestTypeDef

create_case_rule

Creates a new case rule.

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

# create_case_rule method definition

def create_case_rule(
    self,
    *,
    domainId: str,
    name: str,
    rule: CaseRuleDetailsUnionTypeDef,  # (1)
    description: str = ...,
) -> CreateCaseRuleResponseTypeDef:  # (2)
    ...

1. See CaseRuleDetailsUnionTypeDef
2. See CreateCaseRuleResponseTypeDef

# create_case_rule method usage example with argument unpacking

kwargs: CreateCaseRuleRequestTypeDef = {  # (1)
    "domainId": ...,
    "name": ...,
    "rule": ...,
}

parent.create_case_rule(**kwargs)

1. See CreateCaseRuleRequestTypeDef

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

# create_domain method definition

def create_domain(
    self,
    *,
    name: str,
) -> CreateDomainResponseTypeDef:  # (1)
    ...

1. See CreateDomainResponseTypeDef

# create_domain method usage example with argument unpacking

kwargs: CreateDomainRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_domain(**kwargs)

1. See CreateDomainRequestTypeDef

create_field

Creates a field in the Cases domain.

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

# create_field method definition

def create_field(
    self,
    *,
    domainId: str,
    name: str,
    type: FieldTypeType,  # (1)
    description: str = ...,
) -> CreateFieldResponseTypeDef:  # (2)
    ...

1. See FieldTypeType
2. See CreateFieldResponseTypeDef

# create_field method usage example with argument unpacking

kwargs: CreateFieldRequestTypeDef = {  # (1)
    "domainId": ...,
    "name": ...,
    "type": ...,
}

parent.create_field(**kwargs)

1. See CreateFieldRequestTypeDef

create_layout

Creates a layout in the Cases domain.

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

# create_layout method definition

def create_layout(
    self,
    *,
    content: LayoutContentUnionTypeDef,  # (1)
    domainId: str,
    name: str,
) -> CreateLayoutResponseTypeDef:  # (2)
    ...

1. See LayoutContentUnionTypeDef
2. See CreateLayoutResponseTypeDef

# create_layout method usage example with argument unpacking

kwargs: CreateLayoutRequestTypeDef = {  # (1)
    "content": ...,
    "domainId": ...,
    "name": ...,
}

parent.create_layout(**kwargs)

1. See CreateLayoutRequestTypeDef

create_related_item

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

# create_related_item method definition

def create_related_item(
    self,
    *,
    caseId: str,
    content: RelatedItemInputContentTypeDef,  # (1)
    domainId: str,
    type: RelatedItemTypeType,  # (2)
    performedBy: UserUnionTypeDef = ...,  # (3)
) -> CreateRelatedItemResponseTypeDef:  # (4)
    ...

1. See RelatedItemInputContentTypeDef
2. See RelatedItemTypeType
3. See UserUnionTypeDef
4. See CreateRelatedItemResponseTypeDef

# create_related_item method usage example with argument unpacking

kwargs: CreateRelatedItemRequestTypeDef = {  # (1)
    "caseId": ...,
    "content": ...,
    "domainId": ...,
    "type": ...,
}

parent.create_related_item(**kwargs)

1. See CreateRelatedItemRequestTypeDef

create_template

Creates a template in the Cases domain.

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

# create_template method definition

def create_template(
    self,
    *,
    domainId: str,
    name: str,
    description: str = ...,
    layoutConfiguration: LayoutConfigurationTypeDef = ...,  # (1)
    requiredFields: Sequence[RequiredFieldTypeDef] = ...,  # (2)
    rules: Sequence[TemplateRuleTypeDef] = ...,  # (3)
    status: TemplateStatusType = ...,  # (4)
) -> CreateTemplateResponseTypeDef:  # (5)
    ...

1. See LayoutConfigurationTypeDef
2. See Sequence[RequiredFieldTypeDef]
3. See Sequence[TemplateRuleTypeDef]
4. See TemplateStatusType
5. See CreateTemplateResponseTypeDef

# create_template method usage example with argument unpacking

kwargs: CreateTemplateRequestTypeDef = {  # (1)
    "domainId": ...,
    "name": ...,
}

parent.create_template(**kwargs)

1. See CreateTemplateRequestTypeDef

delete_case

The DeleteCase API permanently deletes a case and all its associated resources from the cases data store.

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

# delete_case method definition

def delete_case(
    self,
    *,
    caseId: str,
    domainId: str,
) -> Dict[str, Any]:
    ...

# delete_case method usage example with argument unpacking

kwargs: DeleteCaseRequestTypeDef = {  # (1)
    "caseId": ...,
    "domainId": ...,
}

parent.delete_case(**kwargs)

1. See DeleteCaseRequestTypeDef

delete_case_rule

Deletes a case rule.

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

# delete_case_rule method definition

def delete_case_rule(
    self,
    *,
    caseRuleId: str,
    domainId: str,
) -> Dict[str, Any]:
    ...

# delete_case_rule method usage example with argument unpacking

kwargs: DeleteCaseRuleRequestTypeDef = {  # (1)
    "caseRuleId": ...,
    "domainId": ...,
}

parent.delete_case_rule(**kwargs)

1. See DeleteCaseRuleRequestTypeDef

delete_domain

Deletes a Cases domain.

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

# delete_domain method definition

def delete_domain(
    self,
    *,
    domainId: str,
) -> Dict[str, Any]:
    ...

# delete_domain method usage example with argument unpacking

kwargs: DeleteDomainRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.delete_domain(**kwargs)

1. See DeleteDomainRequestTypeDef

delete_field

Deletes a field from a cases template.

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

# delete_field method definition

def delete_field(
    self,
    *,
    domainId: str,
    fieldId: str,
) -> Dict[str, Any]:
    ...

# delete_field method usage example with argument unpacking

kwargs: DeleteFieldRequestTypeDef = {  # (1)
    "domainId": ...,
    "fieldId": ...,
}

parent.delete_field(**kwargs)

1. See DeleteFieldRequestTypeDef

delete_layout

Deletes a layout from a cases template.

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

# delete_layout method definition

def delete_layout(
    self,
    *,
    domainId: str,
    layoutId: str,
) -> Dict[str, Any]:
    ...

# delete_layout method usage example with argument unpacking

kwargs: DeleteLayoutRequestTypeDef = {  # (1)
    "domainId": ...,
    "layoutId": ...,
}

parent.delete_layout(**kwargs)

1. See DeleteLayoutRequestTypeDef

delete_related_item

Deletes the related item resource under a case.

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

# delete_related_item method definition

def delete_related_item(
    self,
    *,
    caseId: str,
    domainId: str,
    relatedItemId: str,
) -> Dict[str, Any]:
    ...

# delete_related_item method usage example with argument unpacking

kwargs: DeleteRelatedItemRequestTypeDef = {  # (1)
    "caseId": ...,
    "domainId": ...,
    "relatedItemId": ...,
}

parent.delete_related_item(**kwargs)

1. See DeleteRelatedItemRequestTypeDef

delete_template

Deletes a cases template.

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

# delete_template method definition

def delete_template(
    self,
    *,
    domainId: str,
    templateId: str,
) -> Dict[str, Any]:
    ...

# delete_template method usage example with argument unpacking

kwargs: DeleteTemplateRequestTypeDef = {  # (1)
    "domainId": ...,
    "templateId": ...,
}

parent.delete_template(**kwargs)

1. See DeleteTemplateRequestTypeDef

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

# get_case method definition

def get_case(
    self,
    *,
    caseId: str,
    domainId: str,
    fields: Sequence[FieldIdentifierTypeDef],  # (1)
    nextToken: str = ...,
) -> GetCaseResponseTypeDef:  # (2)
    ...

1. See Sequence[FieldIdentifierTypeDef]
2. See GetCaseResponseTypeDef

# get_case method usage example with argument unpacking

kwargs: GetCaseRequestTypeDef = {  # (1)
    "caseId": ...,
    "domainId": ...,
    "fields": ...,
}

parent.get_case(**kwargs)

1. See GetCaseRequestTypeDef

get_case_audit_events

Returns the audit history about a specific case if it exists.

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

# get_case_audit_events method definition

def get_case_audit_events(
    self,
    *,
    caseId: str,
    domainId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetCaseAuditEventsResponseTypeDef:  # (1)
    ...

1. See GetCaseAuditEventsResponseTypeDef

# get_case_audit_events method usage example with argument unpacking

kwargs: GetCaseAuditEventsRequestTypeDef = {  # (1)
    "caseId": ...,
    "domainId": ...,
}

parent.get_case_audit_events(**kwargs)

1. See GetCaseAuditEventsRequestTypeDef

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

# get_case_event_configuration method definition

def get_case_event_configuration(
    self,
    *,
    domainId: str,
) -> GetCaseEventConfigurationResponseTypeDef:  # (1)
    ...

1. See GetCaseEventConfigurationResponseTypeDef

# get_case_event_configuration method usage example with argument unpacking

kwargs: GetCaseEventConfigurationRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.get_case_event_configuration(**kwargs)

1. See GetCaseEventConfigurationRequestTypeDef

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

# get_domain method definition

def get_domain(
    self,
    *,
    domainId: str,
) -> GetDomainResponseTypeDef:  # (1)
    ...

1. See GetDomainResponseTypeDef

# get_domain method usage example with argument unpacking

kwargs: GetDomainRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.get_domain(**kwargs)

1. See GetDomainRequestTypeDef

get_layout

Returns the details for the requested layout.

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

# get_layout method definition

def get_layout(
    self,
    *,
    domainId: str,
    layoutId: str,
) -> GetLayoutResponseTypeDef:  # (1)
    ...

1. See GetLayoutResponseTypeDef

# get_layout method usage example with argument unpacking

kwargs: GetLayoutRequestTypeDef = {  # (1)
    "domainId": ...,
    "layoutId": ...,
}

parent.get_layout(**kwargs)

1. See GetLayoutRequestTypeDef

get_template

Returns the details for the requested template.

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

# get_template method definition

def get_template(
    self,
    *,
    domainId: str,
    templateId: str,
) -> GetTemplateResponseTypeDef:  # (1)
    ...

1. See GetTemplateResponseTypeDef

# get_template method usage example with argument unpacking

kwargs: GetTemplateRequestTypeDef = {  # (1)
    "domainId": ...,
    "templateId": ...,
}

parent.get_template(**kwargs)

1. See GetTemplateRequestTypeDef

list_case_rules

Lists all case rules in a Cases domain.

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

# list_case_rules method definition

def list_case_rules(
    self,
    *,
    domainId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCaseRulesResponseTypeDef:  # (1)
    ...

1. See ListCaseRulesResponseTypeDef

# list_case_rules method usage example with argument unpacking

kwargs: ListCaseRulesRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.list_case_rules(**kwargs)

1. See ListCaseRulesRequestTypeDef

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

# list_cases_for_contact method definition

def list_cases_for_contact(
    self,
    *,
    contactArn: str,
    domainId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCasesForContactResponseTypeDef:  # (1)
    ...

1. See ListCasesForContactResponseTypeDef

# list_cases_for_contact method usage example with argument unpacking

kwargs: ListCasesForContactRequestTypeDef = {  # (1)
    "contactArn": ...,
    "domainId": ...,
}

parent.list_cases_for_contact(**kwargs)

1. See ListCasesForContactRequestTypeDef

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

# list_domains method definition

def list_domains(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDomainsResponseTypeDef:  # (1)
    ...

1. See ListDomainsResponseTypeDef

# list_domains method usage example with argument unpacking

kwargs: ListDomainsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_domains(**kwargs)

1. See ListDomainsRequestTypeDef

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

# list_field_options method definition

def list_field_options(
    self,
    *,
    domainId: str,
    fieldId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    values: Sequence[str] = ...,
) -> ListFieldOptionsResponseTypeDef:  # (1)
    ...

1. See ListFieldOptionsResponseTypeDef

# list_field_options method usage example with argument unpacking

kwargs: ListFieldOptionsRequestTypeDef = {  # (1)
    "domainId": ...,
    "fieldId": ...,
}

parent.list_field_options(**kwargs)

1. See ListFieldOptionsRequestTypeDef

list_fields

Lists all fields in a Cases domain.

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

# list_fields method definition

def list_fields(
    self,
    *,
    domainId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListFieldsResponseTypeDef:  # (1)
    ...

1. See ListFieldsResponseTypeDef

# list_fields method usage example with argument unpacking

kwargs: ListFieldsRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.list_fields(**kwargs)

1. See ListFieldsRequestTypeDef

list_layouts

Lists all layouts in the given cases domain.

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

# list_layouts method definition

def list_layouts(
    self,
    *,
    domainId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListLayoutsResponseTypeDef:  # (1)
    ...

1. See ListLayoutsResponseTypeDef

# list_layouts method usage example with argument unpacking

kwargs: ListLayoutsRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.list_layouts(**kwargs)

1. See ListLayoutsRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    arn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

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

# list_templates method definition

def list_templates(
    self,
    *,
    domainId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    status: Sequence[TemplateStatusType] = ...,  # (1)
) -> ListTemplatesResponseTypeDef:  # (2)
    ...

1. See Sequence[TemplateStatusType]
2. See ListTemplatesResponseTypeDef

# list_templates method usage example with argument unpacking

kwargs: ListTemplatesRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.list_templates(**kwargs)

1. See ListTemplatesRequestTypeDef

put_case_event_configuration

Adds case event publishing configuration.

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

# put_case_event_configuration method definition

def put_case_event_configuration(
    self,
    *,
    domainId: str,
    eventBridge: EventBridgeConfigurationUnionTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See EventBridgeConfigurationUnionTypeDef

# put_case_event_configuration method usage example with argument unpacking

kwargs: PutCaseEventConfigurationRequestTypeDef = {  # (1)
    "domainId": ...,
    "eventBridge": ...,
}

parent.put_case_event_configuration(**kwargs)

1. See PutCaseEventConfigurationRequestTypeDef

search_cases

Searches for cases within their associated Cases domain.

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

# search_cases 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 Sequence[FieldIdentifierTypeDef]
2. See CaseFilterTypeDef
3. See Sequence[SortTypeDef]
4. See SearchCasesResponseTypeDef

# search_cases method usage example with argument unpacking

kwargs: SearchCasesRequestTypeDef = {  # (1)
    "domainId": ...,
}

parent.search_cases(**kwargs)

1. See SearchCasesRequestTypeDef

search_related_items

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

# search_related_items method definition

def search_related_items(
    self,
    *,
    caseId: str,
    domainId: str,
    filters: Sequence[RelatedItemTypeFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> SearchRelatedItemsResponseTypeDef:  # (2)
    ...

1. See Sequence[RelatedItemTypeFilterTypeDef]
2. See SearchRelatedItemsResponseTypeDef

# search_related_items method usage example with argument unpacking

kwargs: SearchRelatedItemsRequestTypeDef = {  # (1)
    "caseId": ...,
    "domainId": ...,
}

parent.search_related_items(**kwargs)

1. See SearchRelatedItemsRequestTypeDef

tag_resource

Adds tags to a resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    arn: str,
    tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "arn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Untags a resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    arn: str,
    tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "arn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_case

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide.

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

# update_case method definition

def update_case(
    self,
    *,
    caseId: str,
    domainId: str,
    fields: Sequence[FieldValueUnionExtraTypeDef],  # (1)
    performedBy: UserUnionTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See Sequence[FieldValueUnionExtraTypeDef]
2. See UserUnionTypeDef

# update_case method usage example with argument unpacking

kwargs: UpdateCaseRequestTypeDef = {  # (1)
    "caseId": ...,
    "domainId": ...,
    "fields": ...,
}

parent.update_case(**kwargs)

1. See UpdateCaseRequestTypeDef

update_case_rule

Updates a case rule.

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

# update_case_rule method definition

def update_case_rule(
    self,
    *,
    caseRuleId: str,
    domainId: str,
    description: str = ...,
    name: str = ...,
    rule: CaseRuleDetailsUnionTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See CaseRuleDetailsUnionTypeDef

# update_case_rule method usage example with argument unpacking

kwargs: UpdateCaseRuleRequestTypeDef = {  # (1)
    "caseRuleId": ...,
    "domainId": ...,
}

parent.update_case_rule(**kwargs)

1. See UpdateCaseRuleRequestTypeDef

update_field

Updates the properties of an existing field.

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

# update_field method definition

def update_field(
    self,
    *,
    domainId: str,
    fieldId: str,
    description: str = ...,
    name: str = ...,
) -> Dict[str, Any]:
    ...

# update_field method usage example with argument unpacking

kwargs: UpdateFieldRequestTypeDef = {  # (1)
    "domainId": ...,
    "fieldId": ...,
}

parent.update_field(**kwargs)

1. See UpdateFieldRequestTypeDef

update_layout

Updates the attributes of an existing layout.

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

# update_layout method definition

def update_layout(
    self,
    *,
    domainId: str,
    layoutId: str,
    content: LayoutContentUnionTypeDef = ...,  # (1)
    name: str = ...,
) -> Dict[str, Any]:
    ...

1. See LayoutContentUnionTypeDef

# update_layout method usage example with argument unpacking

kwargs: UpdateLayoutRequestTypeDef = {  # (1)
    "domainId": ...,
    "layoutId": ...,
}

parent.update_layout(**kwargs)

1. See UpdateLayoutRequestTypeDef

update_template

Updates the attributes of an existing template.

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

# update_template method definition

def update_template(
    self,
    *,
    domainId: str,
    templateId: str,
    description: str = ...,
    layoutConfiguration: LayoutConfigurationTypeDef = ...,  # (1)
    name: str = ...,
    requiredFields: Sequence[RequiredFieldTypeDef] = ...,  # (2)
    rules: Sequence[TemplateRuleTypeDef] = ...,  # (3)
    status: TemplateStatusType = ...,  # (4)
) -> Dict[str, Any]:
    ...

1. See LayoutConfigurationTypeDef
2. See Sequence[RequiredFieldTypeDef]
3. See Sequence[TemplateRuleTypeDef]
4. See TemplateStatusType

# update_template method usage example with argument unpacking

kwargs: UpdateTemplateRequestTypeDef = {  # (1)
    "domainId": ...,
    "templateId": ...,
}

parent.update_template(**kwargs)

1. See UpdateTemplateRequestTypeDef

get_paginator

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

• client.get_paginator("list_case_rules") -> ListCaseRulesPaginator
• client.get_paginator("search_cases") -> SearchCasesPaginator
• client.get_paginator("search_related_items") -> SearchRelatedItemsPaginator