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

# 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)
    ...
  1. See FieldIdentifierTypeDef
  2. See BatchGetFieldResponseTypeDef
# batch_get_field method usage example with argument unpacking

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

# batch_put_field_options method definition

def batch_put_field_options(
    self,
    *,
    domainId: str,
    fieldId: str,
    options: Sequence[FieldOptionTypeDef],  # (1)
) -> BatchPutFieldOptionsResponseTypeDef:  # (2)
    ...
  1. See FieldOptionTypeDef
  2. See BatchPutFieldOptionsResponseTypeDef
# batch_put_field_options method usage example with argument unpacking

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

# 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[FieldValueTypeDef],  # (1)
    templateId: str,
    clientToken: str = ...,
    performedBy: UserUnionTypeDef = ...,  # (2)
) -> CreateCaseResponseTypeDef:  # (3)
    ...
  1. See FieldValueTypeDef
  2. See UserUnionTypeDef
  3. See CreateCaseResponseTypeDef
# create_case method usage example with argument unpacking

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

# create_domain method definition

def create_domain(
    self,
    *,
    name: str,
) -> CreateDomainResponseTypeDef:  # (1)
    ...
  1. See CreateDomainResponseTypeDef
# create_domain method usage example with argument unpacking

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

# 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: 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

# create_layout method definition

def create_layout(
    self,
    *,
    content: LayoutContentTypeDef,  # (1)
    domainId: str,
    name: str,
) -> CreateLayoutResponseTypeDef:  # (2)
    ...
  1. See LayoutContentTypeDef
  2. See CreateLayoutResponseTypeDef
# create_layout method usage example with argument unpacking

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

# 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: 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

# 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)
    ...
  1. See LayoutConfigurationTypeDef
  2. See RequiredFieldTypeDef
  3. See TemplateStatusType
  4. See CreateTemplateResponseTypeDef
# create_template method usage example with argument unpacking

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

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

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)
  1. See DeleteDomainRequestRequestTypeDef

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)
    ...
  1. See FieldIdentifierTypeDef
  2. See GetCaseResponseTypeDef
# get_case method usage example with argument unpacking

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

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

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: GetCaseAuditEventsRequestRequestTypeDef = {  # (1)
    "caseId": ...,
    "domainId": ...,
}

parent.get_case_audit_events(**kwargs)
  1. See GetCaseAuditEventsRequestRequestTypeDef

get_case_event_configuration#

Returns the case event publishing configuration.

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