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#
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)
...
# batch_get_field method usage example with argument unpacking
kwargs: BatchGetFieldRequestRequestTypeDef = { # (1)
"domainId": ...,
"fields": ...,
}
parent.batch_get_field(**kwargs)
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)
...
# batch_put_field_options method usage example with argument unpacking
kwargs: BatchPutFieldOptionsRequestRequestTypeDef = { # (1)
"domainId": ...,
"fieldId": ...,
"options": ...,
}
parent.batch_put_field_options(**kwargs)
can_paginate#
Check if an operation can be paginated.
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:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("connectcases").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_case#
.
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[FieldValueExtraUnionTypeDef], # (1)
templateId: str,
clientToken: str = ...,
performedBy: UserUnionTypeDef = ..., # (2)
) -> CreateCaseResponseTypeDef: # (3)
...
# create_case method usage example with argument unpacking
kwargs: CreateCaseRequestRequestTypeDef = { # (1)
"domainId": ...,
"fields": ...,
"templateId": ...,
}
parent.create_case(**kwargs)
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)
...
# create_domain method usage example with argument unpacking
kwargs: CreateDomainRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_domain(**kwargs)
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)
...
# create_field method usage example with argument unpacking
kwargs: CreateFieldRequestRequestTypeDef = { # (1)
"domainId": ...,
"name": ...,
"type": ...,
}
parent.create_field(**kwargs)
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: LayoutContentTypeDef, # (1)
domainId: str,
name: str,
) -> CreateLayoutResponseTypeDef: # (2)
...
# create_layout method usage example with argument unpacking
kwargs: CreateLayoutRequestRequestTypeDef = { # (1)
"content": ...,
"domainId": ...,
"name": ...,
}
parent.create_layout(**kwargs)
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)
...
- See RelatedItemInputContentTypeDef
- See RelatedItemTypeType
- See UserUnionTypeDef
- See CreateRelatedItemResponseTypeDef
# create_related_item method usage example with argument unpacking
kwargs: CreateRelatedItemRequestRequestTypeDef = { # (1)
"caseId": ...,
"content": ...,
"domainId": ...,
"type": ...,
}
parent.create_related_item(**kwargs)
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)
status: TemplateStatusType = ..., # (3)
) -> CreateTemplateResponseTypeDef: # (4)
...
- See LayoutConfigurationTypeDef
- See RequiredFieldTypeDef
- See TemplateStatusType
- See CreateTemplateResponseTypeDef
# create_template method usage example with argument unpacking
kwargs: CreateTemplateRequestRequestTypeDef = { # (1)
"domainId": ...,
"name": ...,
}
parent.create_template(**kwargs)
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: DeleteDomainRequestRequestTypeDef = { # (1)
"domainId": ...,
}
parent.delete_domain(**kwargs)
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: DeleteFieldRequestRequestTypeDef = { # (1)
"domainId": ...,
"fieldId": ...,
}
parent.delete_field(**kwargs)
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: DeleteLayoutRequestRequestTypeDef = { # (1)
"domainId": ...,
"layoutId": ...,
}
parent.delete_layout(**kwargs)
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: DeleteTemplateRequestRequestTypeDef = { # (1)
"domainId": ...,
"templateId": ...,
}
parent.delete_template(**kwargs)
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
# generate_presigned_url 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
# get_case method definition
def get_case(
self,
*,
caseId: str,
domainId: str,
fields: Sequence[FieldIdentifierTypeDef], # (1)
nextToken: str = ...,
) -> GetCaseResponseTypeDef: # (2)
...
# get_case method usage example with argument unpacking
kwargs: GetCaseRequestRequestTypeDef = { # (1)
"caseId": ...,
"domainId": ...,
"fields": ...,
}
parent.get_case(**kwargs)
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)
...
# get_case_audit_events method usage example with argument unpacking
kwargs: GetCaseAuditEventsRequestRequestTypeDef = { # (1)
"caseId": ...,
"domainId": ...,
}
parent.get_case_audit_events(**kwargs)
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)
...
# get_case_event_configuration method usage example with argument unpacking
kwargs: GetCaseEventConfigurationRequestRequestTypeDef = { # (1)
"domainId": ...,
}
parent.get_case_event_configuration(**kwargs)
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)
...
# get_domain method usage example with argument unpacking
kwargs: GetDomainRequestRequestTypeDef = { # (1)
"domainId": ...,
}
parent.get_domain(**kwargs)
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)
...
# get_layout method usage example with argument unpacking
kwargs: GetLayoutRequestRequestTypeDef = { # (1)
"domainId": ...,
"layoutId": ...,
}
parent.get_layout(**kwargs)
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)
...
# get_template method usage example with argument unpacking
kwargs: GetTemplateRequestRequestTypeDef = { # (1)
"domainId": ...,
"templateId": ...,
}
parent.get_template(**kwargs)
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)
...
# list_cases_for_contact method usage example with argument unpacking
kwargs: ListCasesForContactRequestRequestTypeDef = { # (1)
"contactArn": ...,
"domainId": ...,
}
parent.list_cases_for_contact(**kwargs)
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)
...
# list_domains method usage example with argument unpacking
kwargs: ListDomainsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_domains(**kwargs)
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)
...
# list_field_options method usage example with argument unpacking
kwargs: ListFieldOptionsRequestRequestTypeDef = { # (1)
"domainId": ...,
"fieldId": ...,
}
parent.list_field_options(**kwargs)
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)
...
# list_fields method usage example with argument unpacking
kwargs: ListFieldsRequestRequestTypeDef = { # (1)
"domainId": ...,
}
parent.list_fields(**kwargs)
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)
...
# list_layouts method usage example with argument unpacking
kwargs: ListLayoutsRequestRequestTypeDef = { # (1)
"domainId": ...,
}
parent.list_layouts(**kwargs)
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)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.list_tags_for_resource(**kwargs)
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)
...
# list_templates method usage example with argument unpacking
kwargs: ListTemplatesRequestRequestTypeDef = { # (1)
"domainId": ...,
}
parent.list_templates(**kwargs)
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: EventBridgeConfigurationTypeDef, # (1)
) -> Dict[str, Any]:
...
# put_case_event_configuration method usage example with argument unpacking
kwargs: PutCaseEventConfigurationRequestRequestTypeDef = { # (1)
"domainId": ...,
"eventBridge": ...,
}
parent.put_case_event_configuration(**kwargs)
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)
...
- See FieldIdentifierTypeDef
- See CaseFilterTypeDef
- See SortTypeDef
- See SearchCasesResponseTypeDef
# search_cases method usage example with argument unpacking
kwargs: SearchCasesRequestRequestTypeDef = { # (1)
"domainId": ...,
}
parent.search_cases(**kwargs)
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)
...
# search_related_items method usage example with argument unpacking
kwargs: SearchRelatedItemsRequestRequestTypeDef = { # (1)
"caseId": ...,
"domainId": ...,
}
parent.search_related_items(**kwargs)
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)
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"arn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
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)
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"arn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_case#
.
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[FieldValueTypeDef], # (1)
performedBy: UserUnionTypeDef = ..., # (2)
) -> Dict[str, Any]:
...
- See FieldValueTypeDef
- See UserUnionTypeDef
# update_case method usage example with argument unpacking
kwargs: UpdateCaseRequestRequestTypeDef = { # (1)
"caseId": ...,
"domainId": ...,
"fields": ...,
}
parent.update_case(**kwargs)
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: UpdateFieldRequestRequestTypeDef = { # (1)
"domainId": ...,
"fieldId": ...,
}
parent.update_field(**kwargs)
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: LayoutContentTypeDef = ..., # (1)
name: str = ...,
) -> Dict[str, Any]:
...
# update_layout method usage example with argument unpacking
kwargs: UpdateLayoutRequestRequestTypeDef = { # (1)
"domainId": ...,
"layoutId": ...,
}
parent.update_layout(**kwargs)
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)
status: TemplateStatusType = ..., # (3)
) -> Dict[str, Any]:
...
# update_template method usage example with argument unpacking
kwargs: UpdateTemplateRequestRequestTypeDef = { # (1)
"domainId": ...,
"templateId": ...,
}
parent.update_template(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("connectcases").get_paginator
method with overloads.
client.get_paginator("search_cases")
-> SearchCasesPaginatorclient.get_paginator("search_related_items")
-> SearchRelatedItemsPaginator