ConnectCases

Client

class ConnectCases.Client

A low-level client representing Amazon Connect Cases (ConnectCases)

Welcome to the Amazon Connect Cases API Reference. This guide provides information about the Amazon Connect Cases API, which you can use to create, update, get, and list Cases domains, fields, field options, layouts, templates, cases, related items, and tags.

<p>For more information about Amazon Connect Cases, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Amazon Connect Cases</a> in the <i>Amazon Connect Administrator Guide</i>. </p>

client = session.create_client('connectcases')

These are the available methods:

batch_get_field(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.batch_get_field(
    domainId='string',
    fields=[
        {
            'id': 'string'
        },
    ]
)
Parameters
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • fields (list) --

    [REQUIRED]

    A list of unique field identifiers.

    • (dict) --

      Object for unique identifier of a field.

      • id (string) -- [REQUIRED]

        Unique identifier of a field.

Return type

dict

Returns

Response Syntax

{
    'errors': [
        {
            'errorCode': 'string',
            'id': 'string',
            'message': 'string'
        },
    ],
    'fields': [
        {
            'description': 'string',
            'fieldArn': 'string',
            'fieldId': 'string',
            'name': 'string',
            'namespace': 'System'|'Custom',
            'tags': {
                'string': 'string'
            },
            'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'
        },
    ]
}

Response Structure

  • (dict) --

    • errors (list) --

      A list of field errors.

      • (dict) --

        Object for errors on fields.

        • errorCode (string) --

          The error code from getting a field.

        • id (string) --

          The field identifier that caused the error.

        • message (string) --

          The error message from getting a field.

    • fields (list) --

      A list of detailed field information.

      • (dict) --

        Object to store detailed field information.

        • description (string) --

          Description of the field.

        • fieldArn (string) --

          The Amazon Resource Name (ARN) of the field.

        • fieldId (string) --

          Unique identifier of the field.

        • name (string) --

          Name of the field.

        • namespace (string) --

          Namespace of the field.

        • tags (dict) --

          A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

          • (string) --
            • (string) --
        • type (string) --

          Type of the field.

Exceptions

batch_put_field_options(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.batch_put_field_options(
    domainId='string',
    fieldId='string',
    options=[
        {
            'active': True|False,
            'name': 'string',
            'value': 'string'
        },
    ]
)
Parameters
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • fieldId (string) --

    [REQUIRED]

    The unique identifier of a field.

  • options (list) --

    [REQUIRED]

    A list of FieldOption objects.

    • (dict) --

      Object for field Options information.

      • active (boolean) -- [REQUIRED]

        Describes whether the FieldOption is active (displayed) or inactive.

      • name (string) -- [REQUIRED]
        FieldOptionName has max length 100 and disallows trailing spaces.
      • value (string) -- [REQUIRED]
        FieldOptionValue has max length 100 and must be alphanumeric with hyphens and underscores.
Return type

dict

Returns

Response Syntax

{
    'errors': [
        {
            'errorCode': 'string',
            'message': 'string',
            'value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • errors (list) --

      A list of field errors.

      • (dict) --

        Object for field Options errors.

        • errorCode (string) --

          Error code from creating or updating field option.

        • message (string) --

          Error message from creating or updating field option.

        • value (string) --

          The field option value that caused the error.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_case(**kwargs)

Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.

Note

customer_id is a required field when creating a case.

See also: AWS API Documentation

Request Syntax

response = client.create_case(
    clientToken='string',
    domainId='string',
    fields=[
        {
            'id': 'string',
            'value': {
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'stringValue': 'string'
            }
        },
    ],
    templateId='string'
)
Parameters
  • clientToken (string) --

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    This field is autopopulated if not provided.

  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • fields (list) --

    [REQUIRED]

    An array of objects with field ID (matching ListFields/DescribeField) and value union data.

    • (dict) --

      Object for case field values.

      • id (string) -- [REQUIRED]

        Unique identifier of a field.

      • value (dict) -- [REQUIRED]

        Union of potential field value types.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

        • booleanValue (boolean) --

          Can be either null, or have a Boolean value type. Only one value can be provided.

        • doubleValue (float) --

          Can be either null, or have a Double number value type. Only one value can be provided.

        • stringValue (string) --

          String value type.

  • templateId (string) --

    [REQUIRED]

    A unique identifier of a template.

Return type

dict

Returns

Response Syntax

{
    'caseArn': 'string',
    'caseId': 'string'
}

Response Structure

  • (dict) --

    • caseArn (string) --

      The Amazon Resource Name (ARN) of the case.

    • caseId (string) --

      A unique identifier of the case.

Exceptions

create_domain(**kwargs)

Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.

Warning

This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API.

See also: AWS API Documentation

Request Syntax

response = client.create_domain(
    name='string'
)
Parameters
name (string) --

[REQUIRED]

The name for your Cases domain. It must be unique for your Amazon Web Services account.

Return type
dict
Returns
Response Syntax
{
    'domainArn': 'string',
    'domainId': 'string',
    'domainStatus': 'Active'|'CreationInProgress'|'CreationFailed'
}

Response Structure

  • (dict) --
    • domainArn (string) --

      The Amazon Resource Name (ARN) for the Cases domain.

    • domainId (string) --

      The unique identifier of the Cases domain.

    • domainStatus (string) --

      The status of the domain.

Exceptions

create_field(**kwargs)

Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.

See also: AWS API Documentation

Request Syntax

response = client.create_field(
    description='string',
    domainId='string',
    name='string',
    type='Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'
)
Parameters
  • description (string) -- The description of the field.
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • name (string) --

    [REQUIRED]

    The name of the field.

  • type (string) --

    [REQUIRED]

    Defines the data type, some system constraints, and default display of the field.

Return type

dict

Returns

Response Syntax

{
    'fieldArn': 'string',
    'fieldId': 'string'
}

Response Structure

  • (dict) --

    • fieldArn (string) --

      The Amazon Resource Name (ARN) of the field.

    • fieldId (string) --

      The unique identifier of a field.

Exceptions

create_layout(**kwargs)

Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:

  • Fields to display to the users
  • Field ordering

Note

Title and Status fields cannot be part of layouts since they are not configurable.

See also: AWS API Documentation

Request Syntax

response = client.create_layout(
    content={
        'basic': {
            'moreInfo': {
                'sections': [
                    {
                        'fieldGroup': {
                            'fields': [
                                {
                                    'id': 'string'
                                },
                            ],
                            'name': 'string'
                        }
                    },
                ]
            },
            'topPanel': {
                'sections': [
                    {
                        'fieldGroup': {
                            'fields': [
                                {
                                    'id': 'string'
                                },
                            ],
                            'name': 'string'
                        }
                    },
                ]
            }
        }
    },
    domainId='string',
    name='string'
)
Parameters
  • content (dict) --

    [REQUIRED]

    Information about which fields will be present in the layout, and information about the order of the fields.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: basic.

    • basic (dict) --

      Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.

      • moreInfo (dict) --

        This represents sections in a tab of the page layout.

        • sections (list) --

          Ordered list containing different kinds of sections that can be added.

          • (dict) --

            This represents a sections within a panel or tab of the page layout.

            Note

            This is a Tagged Union structure. Only one of the following top level keys can be set: fieldGroup.

            • fieldGroup (dict) --

              Consists of a group of fields and associated properties.

              • fields (list) -- [REQUIRED]

                Represents an ordered list containing field related information.

                • (dict) --

                  Object for field related information.

                  • id (string) -- [REQUIRED]

                    Unique identifier of a field.

              • name (string) --

                Name of the field group.

      • topPanel (dict) --

        This represents sections in a panel of the page layout.

        • sections (list) --

          Ordered list containing different kinds of sections that can be added.

          • (dict) --

            This represents a sections within a panel or tab of the page layout.

            Note

            This is a Tagged Union structure. Only one of the following top level keys can be set: fieldGroup.

            • fieldGroup (dict) --

              Consists of a group of fields and associated properties.

              • fields (list) -- [REQUIRED]

                Represents an ordered list containing field related information.

                • (dict) --

                  Object for field related information.

                  • id (string) -- [REQUIRED]

                    Unique identifier of a field.

              • name (string) --

                Name of the field group.

  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • name (string) --

    [REQUIRED]

    The name of the layout. It must be unique for the Cases domain.

Return type

dict

Returns

Response Syntax

{
    'layoutArn': 'string',
    'layoutId': 'string'
}

Response Structure

  • (dict) --

    • layoutArn (string) --

      The Amazon Resource Name (ARN) of the newly created layout.

    • layoutId (string) --

      The unique identifier of the layout.

Exceptions

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

Note

A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn ). All Related Items have their own internal identifier, the relatedItemArn . Examples of related items include comments and contacts .

See also: AWS API Documentation

Request Syntax

response = client.create_related_item(
    caseId='string',
    content={
        'comment': {
            'body': 'string',
            'contentType': 'Text/Plain'
        },
        'contact': {
            'contactArn': 'string'
        }
    },
    domainId='string',
    type='Contact'|'Comment'
)
Parameters
  • caseId (string) --

    [REQUIRED]

    A unique identifier of the case.

  • content (dict) --

    [REQUIRED]

    The content of a related item to be created.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: comment, contact.

    • comment (dict) --

      Represents the content of a comment to be returned to agents.

      • body (string) -- [REQUIRED]

        Text in the body of a Comment on a case.

      • contentType (string) -- [REQUIRED]

        Type of the text in the box of a Comment on a case.

    • contact (dict) --

      Object representing a contact in Amazon Connect as an API request field.

      • contactArn (string) -- [REQUIRED]

        A unique identifier of a contact in Amazon Connect.

  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • type (string) --

    [REQUIRED]

    The type of a related item.

Return type

dict

Returns

Response Syntax

{
    'relatedItemArn': 'string',
    'relatedItemId': 'string'
}

Response Structure

  • (dict) --

    • relatedItemArn (string) --

      The Amazon Resource Name (ARN) of the related item.

    • relatedItemId (string) --

      The unique identifier of the related item.

Exceptions

create_template(**kwargs)

Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

See also: AWS API Documentation

Request Syntax

response = client.create_template(
    description='string',
    domainId='string',
    layoutConfiguration={
        'defaultLayout': 'string'
    },
    name='string',
    requiredFields=[
        {
            'fieldId': 'string'
        },
    ],
    status='Active'|'Inactive'
)
Parameters
  • description (string) -- A brief description of the template.
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • layoutConfiguration (dict) --

    Configuration of layouts associated to the template.

    • defaultLayout (string) --

      Unique identifier of a layout.

  • name (string) --

    [REQUIRED]

    A name for the template. It must be unique per domain.

  • requiredFields (list) --

    A list of fields that must contain a value for a case to be successfully created with this template.

    • (dict) --

      List of fields that must have a value provided to create a case.

      • fieldId (string) -- [REQUIRED]

        Unique identifier of a field.

  • status (string) -- The status of the template.
Return type

dict

Returns

Response Syntax

{
    'templateArn': 'string',
    'templateId': 'string'
}

Response Structure

  • (dict) --

    • templateArn (string) --

      The Amazon Resource Name (ARN) of the newly created template.

    • templateId (string) --

      A unique identifier of a template.

Exceptions

get_case(**kwargs)

Returns information about a specific case if it exists.

See also: AWS API Documentation

Request Syntax

response = client.get_case(
    caseId='string',
    domainId='string',
    fields=[
        {
            'id': 'string'
        },
    ],
    nextToken='string'
)
Parameters
  • caseId (string) --

    [REQUIRED]

    A unique identifier of the case.

  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • fields (list) --

    [REQUIRED]

    A list of unique field identifiers.

    • (dict) --

      Object for unique identifier of a field.

      • id (string) -- [REQUIRED]

        Unique identifier of a field.

  • nextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Return type

dict

Returns

Response Syntax

{
    'fields': [
        {
            'id': 'string',
            'value': {
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'stringValue': 'string'
            }
        },
    ],
    'nextToken': 'string',
    'tags': {
        'string': 'string'
    },
    'templateId': 'string'
}

Response Structure

  • (dict) --

    • fields (list) --

      A list of detailed field information.

      • (dict) --

        Object for case field values.

        • id (string) --

          Unique identifier of a field.

        • value (dict) --

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: booleanValue, doubleValue, stringValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

    • nextToken (string) --

      The token for the next set of results. This is null if there are no more results to return.

    • tags (dict) --

      A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

      • (string) --
        • (string) --
    • templateId (string) --

      A unique identifier of a template.

Exceptions

get_case_event_configuration(**kwargs)

Returns the case event publishing configuration.

See also: AWS API Documentation

Request Syntax

response = client.get_case_event_configuration(
    domainId='string'
)
Parameters
domainId (string) --

[REQUIRED]

The unique identifier of the Cases domain.

Return type
dict
Returns
Response Syntax
{
    'eventBridge': {
        'enabled': True|False,
        'includedData': {
            'caseData': {
                'fields': [
                    {
                        'id': 'string'
                    },
                ]
            },
            'relatedItemData': {
                'includeContent': True|False
            }
        }
    }
}

Response Structure

  • (dict) --
    • eventBridge (dict) --

      Configuration to enable EventBridge case event delivery and determine what data is delivered.

      • enabled (boolean) --

        Indicates whether the to broadcast case event data to the customer.

      • includedData (dict) --

        Details of what case and related item data is published through the case event stream.

        • caseData (dict) --

          Details of what case data is published through the case event stream.

          • fields (list) --

            List of field identifiers.

            • (dict) --

              Object for unique identifier of a field.

              • id (string) --

                Unique identifier of a field.

        • relatedItemData (dict) --

          Details of what related item data is published through the case event stream.

          • includeContent (boolean) --

            Details of what related item data is published through the case event stream.

Exceptions

get_domain(**kwargs)

Returns information about a specific domain if it exists.

See also: AWS API Documentation

Request Syntax

response = client.get_domain(
    domainId='string'
)
Parameters
domainId (string) --

[REQUIRED]

The unique identifier of the Cases domain.

Return type
dict
Returns
Response Syntax
{
    'createdTime': datetime(2015, 1, 1),
    'domainArn': 'string',
    'domainId': 'string',
    'domainStatus': 'Active'|'CreationInProgress'|'CreationFailed',
    'name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • createdTime (datetime) --

      The timestamp when the Cases domain was created.

    • domainArn (string) --

      The Amazon Resource Name (ARN) for the Cases domain.

    • domainId (string) --

      The unique identifier of the Cases domain.

    • domainStatus (string) --

      The status of the Cases domain.

    • name (string) --

      The name of the Cases domain.

    • tags (dict) --

      A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

      • (string) --
        • (string) --

Exceptions

get_layout(**kwargs)

Returns the details for the requested layout.

See also: AWS API Documentation

Request Syntax

response = client.get_layout(
    domainId='string',
    layoutId='string'
)
Parameters
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • layoutId (string) --

    [REQUIRED]

    The unique identifier of the layout.

Return type

dict

Returns

Response Syntax

{
    'content': {
        'basic': {
            'moreInfo': {
                'sections': [
                    {
                        'fieldGroup': {
                            'fields': [
                                {
                                    'id': 'string'
                                },
                            ],
                            'name': 'string'
                        }
                    },
                ]
            },
            'topPanel': {
                'sections': [
                    {
                        'fieldGroup': {
                            'fields': [
                                {
                                    'id': 'string'
                                },
                            ],
                            'name': 'string'
                        }
                    },
                ]
            }
        }
    },
    'layoutArn': 'string',
    'layoutId': 'string',
    'name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • content (dict) --

      Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: basic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      
      • basic (dict) --

        Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.

        • moreInfo (dict) --

          This represents sections in a tab of the page layout.

          • sections (list) --

            Ordered list containing different kinds of sections that can be added.

            • (dict) --

              This represents a sections within a panel or tab of the page layout.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: fieldGroup. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              
              • fieldGroup (dict) --

                Consists of a group of fields and associated properties.

                • fields (list) --

                  Represents an ordered list containing field related information.

                  • (dict) --

                    Object for field related information.

                    • id (string) --

                      Unique identifier of a field.

                • name (string) --

                  Name of the field group.

        • topPanel (dict) --

          This represents sections in a panel of the page layout.

          • sections (list) --

            Ordered list containing different kinds of sections that can be added.

            • (dict) --

              This represents a sections within a panel or tab of the page layout.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: fieldGroup. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              
              • fieldGroup (dict) --

                Consists of a group of fields and associated properties.

                • fields (list) --

                  Represents an ordered list containing field related information.

                  • (dict) --

                    Object for field related information.

                    • id (string) --

                      Unique identifier of a field.

                • name (string) --

                  Name of the field group.

    • layoutArn (string) --

      The Amazon Resource Name (ARN) of the newly created layout.

    • layoutId (string) --

      The unique identifier of the layout.

    • name (string) --

      The name of the layout. It must be unique.

    • tags (dict) --

      A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

      • (string) --
        • (string) --

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_template(**kwargs)

Returns the details for the requested template.

See also: AWS API Documentation

Request Syntax

response = client.get_template(
    domainId='string',
    templateId='string'
)
Parameters
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • templateId (string) --

    [REQUIRED]

    A unique identifier of a template.

Return type

dict

Returns

Response Syntax

{
    'description': 'string',
    'layoutConfiguration': {
        'defaultLayout': 'string'
    },
    'name': 'string',
    'requiredFields': [
        {
            'fieldId': 'string'
        },
    ],
    'status': 'Active'|'Inactive',
    'tags': {
        'string': 'string'
    },
    'templateArn': 'string',
    'templateId': 'string'
}

Response Structure

  • (dict) --

    • description (string) --

      A brief description of the template.

    • layoutConfiguration (dict) --

      Configuration of layouts associated to the template.

      • defaultLayout (string) --

        Unique identifier of a layout.

    • name (string) --

      The name of the template.

    • requiredFields (list) --

      A list of fields that must contain a value for a case to be successfully created with this template.

      • (dict) --

        List of fields that must have a value provided to create a case.

        • fieldId (string) --

          Unique identifier of a field.

    • status (string) --

      The status of the template.

    • tags (dict) --

      A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

      • (string) --
        • (string) --
    • templateArn (string) --

      The Amazon Resource Name (ARN) of the template.

    • templateId (string) --

      A unique identifier of a template.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_cases_for_contact(**kwargs)

Lists cases for a given contact.

See also: AWS API Documentation

Request Syntax

response = client.list_cases_for_contact(
    contactArn='string',
    domainId='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • contactArn (string) --

    [REQUIRED]

    A unique identifier of a contact in Amazon Connect.

  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • maxResults (integer) -- The maximum number of results to return per page.
  • nextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Return type

dict

Returns

Response Syntax

{
    'cases': [
        {
            'caseId': 'string',
            'templateId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • cases (list) --

      A list of Case summary information.

      • (dict) --

        Case summary information.

        • caseId (string) --

          A unique identifier of the case.

        • templateId (string) --

          A unique identifier of a template.

    • nextToken (string) --

      The token for the next set of results. This is null if there are no more results to return.

Exceptions

list_domains(**kwargs)

Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.

See also: AWS API Documentation

Request Syntax

response = client.list_domains(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to return per page.
  • nextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Return type

dict

Returns

Response Syntax

{
    'domains': [
        {
            'domainArn': 'string',
            'domainId': 'string',
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • domains (list) --

      The Cases domain.

      • (dict) --

        Object for the summarized details of the domain.

        • domainArn (string) --

          The Amazon Resource Name (ARN) of the domain.

        • domainId (string) --

          The unique identifier of the domain.

        • name (string) --

          The name of the domain.

    • nextToken (string) --

      The token for the next set of results. This is null if there are no more results to return.

Exceptions

list_field_options(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_field_options(
    domainId='string',
    fieldId='string',
    maxResults=123,
    nextToken='string',
    values=[
        'string',
    ]
)
Parameters
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • fieldId (string) --

    [REQUIRED]

    The unique identifier of a field.

  • maxResults (integer) -- The maximum number of results to return per page.
  • nextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  • values (list) --

    A list of FieldOption values to filter on for ListFieldOptions .

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'options': [
        {
            'active': True|False,
            'name': 'string',
            'value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token for the next set of results. This is null if there are no more results to return.

    • options (list) --

      A list of FieldOption objects.

      • (dict) --

        Object for field Options information.

        • active (boolean) --

          Describes whether the FieldOption is active (displayed) or inactive.

        • name (string) --

          FieldOptionName has max length 100 and disallows trailing spaces.

        • value (string) --

          FieldOptionValue has max length 100 and must be alphanumeric with hyphens and underscores.

Exceptions

list_fields(**kwargs)

Lists all fields in a Cases domain.

See also: AWS API Documentation

Request Syntax

response = client.list_fields(
    domainId='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • maxResults (integer) -- The maximum number of results to return per page.
  • nextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Return type

dict

Returns

Response Syntax

{
    'fields': [
        {
            'fieldArn': 'string',
            'fieldId': 'string',
            'name': 'string',
            'namespace': 'System'|'Custom',
            'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • fields (list) --

      List of detailed field information.

      • (dict) --

        Object for the summarized details of the field.

        • fieldArn (string) --

          The Amazon Resource Name (ARN) of the field.

        • fieldId (string) --

          The unique identifier of a field.

        • name (string) --

          Name of the field.

        • namespace (string) --

          The namespace of a field.

        • type (string) --

          The type of a field.

    • nextToken (string) --

      The token for the next set of results. This is null if there are no more results to return.

Exceptions

list_layouts(**kwargs)

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

See also: AWS API Documentation

Request Syntax

response = client.list_layouts(
    domainId='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • maxResults (integer) -- The maximum number of results to return per page.
  • nextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Return type

dict

Returns

Response Syntax

{
    'layouts': [
        {
            'layoutArn': 'string',
            'layoutId': 'string',
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • layouts (list) --

      The layouts for the domain.

      • (dict) --

        Object for the summarized details of the layout.

        • layoutArn (string) --

          The Amazon Resource Name (ARN) of the layout.

        • layoutId (string) --

          The unique identifier for of the layout.

        • name (string) --

          The name of the layout.

    • nextToken (string) --

      The token for the next set of results. This is null if there are no more results to return.

Exceptions

list_tags_for_resource(**kwargs)

Lists tags for a resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    arn='string'
)
Parameters
arn (string) --

[REQUIRED]

The Amazon Resource Name (ARN)

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

      • (string) --
        • (string) --

Exceptions

list_templates(**kwargs)

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.

See also: AWS API Documentation

Request Syntax

response = client.list_templates(
    domainId='string',
    maxResults=123,
    nextToken='string',
    status=[
        'Active'|'Inactive',
    ]
)
Parameters
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • maxResults (integer) -- The maximum number of results to return per page.
  • nextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  • status (list) --

    A list of status values to filter on.

    • (string) --

      Status of a template

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'templates': [
        {
            'name': 'string',
            'status': 'Active'|'Inactive',
            'templateArn': 'string',
            'templateId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token for the next set of results. This is null if there are no more results to return.

    • templates (list) --

      List of template summary objects.

      • (dict) --

        Template summary information.

        • name (string) --

          The template name.

        • status (string) --

          The status of the template.

        • templateArn (string) --

          The Amazon Resource Name (ARN) of the template.

        • templateId (string) --

          The unique identifier for the template.

Exceptions

put_case_event_configuration(**kwargs)

API for adding case event publishing configuration

See also: AWS API Documentation

Request Syntax

response = client.put_case_event_configuration(
    domainId='string',
    eventBridge={
        'enabled': True|False,
        'includedData': {
            'caseData': {
                'fields': [
                    {
                        'id': 'string'
                    },
                ]
            },
            'relatedItemData': {
                'includeContent': True|False
            }
        }
    }
)
Parameters
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • eventBridge (dict) --

    [REQUIRED]

    Configuration to enable EventBridge case event delivery and determine what data is delivered.

    • enabled (boolean) -- [REQUIRED]

      Indicates whether the to broadcast case event data to the customer.

    • includedData (dict) --

      Details of what case and related item data is published through the case event stream.

      • caseData (dict) --

        Details of what case data is published through the case event stream.

        • fields (list) -- [REQUIRED]

          List of field identifiers.

          • (dict) --

            Object for unique identifier of a field.

            • id (string) -- [REQUIRED]

              Unique identifier of a field.

      • relatedItemData (dict) --

        Details of what related item data is published through the case event stream.

        • includeContent (boolean) -- [REQUIRED]

          Details of what related item data is published through the case event stream.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

search_cases(**kwargs)

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

See also: AWS API Documentation

Request Syntax

response = client.search_cases(
    domainId='string',
    fields=[
        {
            'id': 'string'
        },
    ],
    filter={
        'andAll': [
            {'... recursive ...'},
        ],
        'field': {
            'contains': {
                'id': 'string',
                'value': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'stringValue': 'string'
                }
            },
            'equalTo': {
                'id': 'string',
                'value': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'stringValue': 'string'
                }
            },
            'greaterThan': {
                'id': 'string',
                'value': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'stringValue': 'string'
                }
            },
            'greaterThanOrEqualTo': {
                'id': 'string',
                'value': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'stringValue': 'string'
                }
            },
            'lessThan': {
                'id': 'string',
                'value': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'stringValue': 'string'
                }
            },
            'lessThanOrEqualTo': {
                'id': 'string',
                'value': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'stringValue': 'string'
                }
            }
        },
        'not': {'... recursive ...'}
    },
    maxResults=123,
    nextToken='string',
    searchTerm='string',
    sorts=[
        {
            'fieldId': 'string',
            'sortOrder': 'Asc'|'Desc'
        },
    ]
)
Parameters
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • fields (list) --

    The list of field identifiers to be returned as part of the response.

    • (dict) --

      Object for unique identifier of a field.

      • id (string) -- [REQUIRED]

        Unique identifier of a field.

  • filter (dict) --

    A list of filter objects.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: andAll, field, not.

    • andAll (list) --

      Provides "and all" filtering.

      • (dict) --

        A filter for cases. Only one value can be provided.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: andAll, field, not.

    • field (dict) --

      A list of fields to filter on.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: contains, equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo.

      • contains (dict) --

        Object containing field identifier and value information.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

      • equalTo (dict) --

        Object containing field identifier and value information.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

      • greaterThan (dict) --

        Object containing field identifier and value information.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

      • greaterThanOrEqualTo (dict) --

        Object containing field identifier and value information.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

      • lessThan (dict) --

        Object containing field identifier and value information.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

      • lessThanOrEqualTo (dict) --

        Object containing field identifier and value information.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

    • not (dict) --

      A filter for cases. Only one value can be provided.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: andAll, field, not.

  • maxResults (integer) -- The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.
  • nextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  • searchTerm (string) -- A word or phrase used to perform a quick search.
  • sorts (list) --

    A list of sorts where each sort specifies a field and their sort order to be applied to the results.

    • (dict) --

      A structured set of sort terms.

      • fieldId (string) -- [REQUIRED]

        Unique identifier of a field.

      • sortOrder (string) -- [REQUIRED]

        A structured set of sort terms

Return type

dict

Returns

Response Syntax

{
    'cases': [
        {
            'caseId': 'string',
            'fields': [
                {
                    'id': 'string',
                    'value': {
                        'booleanValue': True|False,
                        'doubleValue': 123.0,
                        'stringValue': 'string'
                    }
                },
            ],
            'tags': {
                'string': 'string'
            },
            'templateId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • cases (list) --

      A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.

      • (dict) --

        A list of items that represent cases.

        • caseId (string) --

          A unique identifier of the case.

        • fields (list) --

          List of case field values.

          • (dict) --

            Object for case field values.

            • id (string) --

              Unique identifier of a field.

            • value (dict) --

              Union of potential field value types.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: booleanValue, doubleValue, stringValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              
              • booleanValue (boolean) --

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue (float) --

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue (string) --

                String value type.

        • tags (dict) --

          A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

          • (string) --
            • (string) --
        • templateId (string) --

          A unique identifier of a template.

    • nextToken (string) --

      The token for the next set of results. This is null if there are no more results to return.

Exceptions

Searches for related items that are associated with a case.

Note

If no filters are provided, this returns all related items associated with a case.

See also: AWS API Documentation

Request Syntax

response = client.search_related_items(
    caseId='string',
    domainId='string',
    filters=[
        {
            'comment': {}
            ,
            'contact': {
                'channel': [
                    'string',
                ],
                'contactArn': 'string'
            }
        },
    ],
    maxResults=123,
    nextToken='string'
)
Parameters
  • caseId (string) --

    [REQUIRED]

    A unique identifier of the case.

  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • filters (list) --

    The list of types of related items and their parameters to use for filtering.

    • (dict) --

      The list of types of related items and their parameters to use for filtering.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: comment, contact.

      • comment (dict) --

        A filter for related items of type Comment .

      • contact (dict) --

        A filter for related items of type Contact .

        • channel (list) --

          A list of channels to filter on for related items of type Contact .

          • (string) --
        • contactArn (string) --

          A unique identifier of a contact in Amazon Connect.

  • maxResults (integer) -- The maximum number of results to return per page.
  • nextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'relatedItems': [
        {
            'associationTime': datetime(2015, 1, 1),
            'content': {
                'comment': {
                    'body': 'string',
                    'contentType': 'Text/Plain'
                },
                'contact': {
                    'channel': 'string',
                    'connectedToSystemTime': datetime(2015, 1, 1),
                    'contactArn': 'string'
                }
            },
            'relatedItemId': 'string',
            'tags': {
                'string': 'string'
            },
            'type': 'Contact'|'Comment'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token for the next set of results. This is null if there are no more results to return.

    • relatedItems (list) --

      A list of items related to a case.

      • (dict) --

        A list of items that represent RelatedItems.

        • associationTime (datetime) --

          Time at which a related item was associated with a case.

        • content (dict) --

          Represents the content of a particular type of related item.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: comment, contact. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • comment (dict) --

            Represents the content of a comment to be returned to agents.

            • body (string) --

              Text in the body of a Comment on a case.

            • contentType (string) --

              Type of the text in the box of a Comment on a case.

          • contact (dict) --

            Represents the content of a contact to be returned to agents.

            • channel (string) --

              A list of channels to filter on for related items of type Contact .

            • connectedToSystemTime (datetime) --

              The difference between the InitiationTimestamp and the DisconnectTimestamp of the contact.

            • contactArn (string) --

              A unique identifier of a contact in Amazon Connect.

        • relatedItemId (string) --

          Unique identifier of a related item.

        • tags (dict) --

          A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

          • (string) --
            • (string) --
        • type (string) --

          Type of a related item.

Exceptions

tag_resource(**kwargs)

Adds tags to a resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    arn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • arn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN)

  • tags (dict) --

    [REQUIRED]

    A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

    • (string) --
      • (string) --
Returns

None

Exceptions

untag_resource(**kwargs)

Untags a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    arn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • arn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN)

  • tagKeys (list) --

    [REQUIRED]

    List of tag keys.

    • (string) --
Returns

None

Exceptions

update_case(**kwargs)

Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the CreateCase input .

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

See also: AWS API Documentation

Request Syntax

response = client.update_case(
    caseId='string',
    domainId='string',
    fields=[
        {
            'id': 'string',
            'value': {
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'stringValue': 'string'
            }
        },
    ]
)
Parameters
  • caseId (string) --

    [REQUIRED]

    A unique identifier of the case.

  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • fields (list) --

    [REQUIRED]

    An array of objects with fieldId (matching ListFields/DescribeField) and value union data, structured identical to CreateCase .

    • (dict) --

      Object for case field values.

      • id (string) -- [REQUIRED]

        Unique identifier of a field.

      • value (dict) -- [REQUIRED]

        Union of potential field value types.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

        • booleanValue (boolean) --

          Can be either null, or have a Boolean value type. Only one value can be provided.

        • doubleValue (float) --

          Can be either null, or have a Double number value type. Only one value can be provided.

        • stringValue (string) --

          String value type.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_field(**kwargs)

Updates the properties of an existing field.

See also: AWS API Documentation

Request Syntax

response = client.update_field(
    description='string',
    domainId='string',
    fieldId='string',
    name='string'
)
Parameters
  • description (string) -- The description of a field.
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • fieldId (string) --

    [REQUIRED]

    The unique identifier of a field.

  • name (string) -- The name of the field.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_layout(**kwargs)

Updates the attributes of an existing layout.

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

A ValidationException is returned when you add non-existent fieldIds to a layout.

Note

Title and Status fields cannot be part of layouts because they are not configurable.

See also: AWS API Documentation

Request Syntax

response = client.update_layout(
    content={
        'basic': {
            'moreInfo': {
                'sections': [
                    {
                        'fieldGroup': {
                            'fields': [
                                {
                                    'id': 'string'
                                },
                            ],
                            'name': 'string'
                        }
                    },
                ]
            },
            'topPanel': {
                'sections': [
                    {
                        'fieldGroup': {
                            'fields': [
                                {
                                    'id': 'string'
                                },
                            ],
                            'name': 'string'
                        }
                    },
                ]
            }
        }
    },
    domainId='string',
    layoutId='string',
    name='string'
)
Parameters
  • content (dict) --

    Information about which fields will be present in the layout, the order of the fields, and a read-only attribute of the field.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: basic.

    • basic (dict) --

      Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.

      • moreInfo (dict) --

        This represents sections in a tab of the page layout.

        • sections (list) --

          Ordered list containing different kinds of sections that can be added.

          • (dict) --

            This represents a sections within a panel or tab of the page layout.

            Note

            This is a Tagged Union structure. Only one of the following top level keys can be set: fieldGroup.

            • fieldGroup (dict) --

              Consists of a group of fields and associated properties.

              • fields (list) -- [REQUIRED]

                Represents an ordered list containing field related information.

                • (dict) --

                  Object for field related information.

                  • id (string) -- [REQUIRED]

                    Unique identifier of a field.

              • name (string) --

                Name of the field group.

      • topPanel (dict) --

        This represents sections in a panel of the page layout.

        • sections (list) --

          Ordered list containing different kinds of sections that can be added.

          • (dict) --

            This represents a sections within a panel or tab of the page layout.

            Note

            This is a Tagged Union structure. Only one of the following top level keys can be set: fieldGroup.

            • fieldGroup (dict) --

              Consists of a group of fields and associated properties.

              • fields (list) -- [REQUIRED]

                Represents an ordered list containing field related information.

                • (dict) --

                  Object for field related information.

                  • id (string) -- [REQUIRED]

                    Unique identifier of a field.

              • name (string) --

                Name of the field group.

  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • layoutId (string) --

    [REQUIRED]

    The unique identifier of the layout.

  • name (string) -- The name of the layout. It must be unique per domain.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_template(**kwargs)

Updates the attributes of an existing template. The template attributes that can be modified include name , description , layoutConfiguration , requiredFields , and status . At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.

See also: AWS API Documentation

Request Syntax

response = client.update_template(
    description='string',
    domainId='string',
    layoutConfiguration={
        'defaultLayout': 'string'
    },
    name='string',
    requiredFields=[
        {
            'fieldId': 'string'
        },
    ],
    status='Active'|'Inactive',
    templateId='string'
)
Parameters
  • description (string) -- A brief description of the template.
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • layoutConfiguration (dict) --

    Configuration of layouts associated to the template.

    • defaultLayout (string) --

      Unique identifier of a layout.

  • name (string) -- The name of the template. It must be unique per domain.
  • requiredFields (list) --

    A list of fields that must contain a value for a case to be successfully created with this template.

    • (dict) --

      List of fields that must have a value provided to create a case.

      • fieldId (string) -- [REQUIRED]

        Unique identifier of a field.

  • status (string) -- The status of the template.
  • templateId (string) --

    [REQUIRED]

    A unique identifier for the template.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class ConnectCases.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ConnectCases.Client.exceptions.ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ConnectCases.Client.exceptions.InternalServerException

We couldn't process your request because of an issue with the server. Try again later.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'retryAfterSeconds': 123,
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    We couldn't process your request because of an issue with the server. Try again later.

    • message (string) --

    • retryAfterSeconds (integer) --

      Advice to clients on when the call can be safely retried.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ConnectCases.Client.exceptions.ResourceNotFoundException

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

    • message (string) --

    • resourceId (string) --

      Unique identifier of the resource affected.

    • resourceType (string) --

      Type of the resource affected.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ConnectCases.Client.exceptions.ServiceQuotaExceededException

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide .

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide .

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ConnectCases.Client.exceptions.ThrottlingException

The rate has been exceeded for this API. Please try again after a few minutes.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The rate has been exceeded for this API. Please try again after a few minutes.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ConnectCases.Client.exceptions.ValidationException

The request isn't valid. Check the syntax and try again.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request isn't valid. Check the syntax and try again.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class ConnectCases.Paginator.SearchCases
paginator = client.get_paginator('search_cases')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectCases.Client.search_cases().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainId='string',
    fields=[
        {
            'id': 'string'
        },
    ],
    filter={
        'andAll': [
            {'... recursive ...'},
        ],
        'field': {
            'contains': {
                'id': 'string',
                'value': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'stringValue': 'string'
                }
            },
            'equalTo': {
                'id': 'string',
                'value': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'stringValue': 'string'
                }
            },
            'greaterThan': {
                'id': 'string',
                'value': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'stringValue': 'string'
                }
            },
            'greaterThanOrEqualTo': {
                'id': 'string',
                'value': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'stringValue': 'string'
                }
            },
            'lessThan': {
                'id': 'string',
                'value': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'stringValue': 'string'
                }
            },
            'lessThanOrEqualTo': {
                'id': 'string',
                'value': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'stringValue': 'string'
                }
            }
        },
        'not': {'... recursive ...'}
    },
    searchTerm='string',
    sorts=[
        {
            'fieldId': 'string',
            'sortOrder': 'Asc'|'Desc'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • fields (list) --

    The list of field identifiers to be returned as part of the response.

    • (dict) --

      Object for unique identifier of a field.

      • id (string) -- [REQUIRED]

        Unique identifier of a field.

  • filter (dict) --

    A list of filter objects.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: andAll, field, not.

    • andAll (list) --

      Provides "and all" filtering.

      • (dict) --

        A filter for cases. Only one value can be provided.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: andAll, field, not.

    • field (dict) --

      A list of fields to filter on.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: contains, equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo.

      • contains (dict) --

        Object containing field identifier and value information.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

      • equalTo (dict) --

        Object containing field identifier and value information.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

      • greaterThan (dict) --

        Object containing field identifier and value information.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

      • greaterThanOrEqualTo (dict) --

        Object containing field identifier and value information.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

      • lessThan (dict) --

        Object containing field identifier and value information.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

      • lessThanOrEqualTo (dict) --

        Object containing field identifier and value information.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue (string) --

            String value type.

    • not (dict) --

      A filter for cases. Only one value can be provided.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: andAll, field, not.

  • searchTerm (string) -- A word or phrase used to perform a quick search.
  • sorts (list) --

    A list of sorts where each sort specifies a field and their sort order to be applied to the results.

    • (dict) --

      A structured set of sort terms.

      • fieldId (string) -- [REQUIRED]

        Unique identifier of a field.

      • sortOrder (string) -- [REQUIRED]

        A structured set of sort terms

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'cases': [
        {
            'caseId': 'string',
            'fields': [
                {
                    'id': 'string',
                    'value': {
                        'booleanValue': True|False,
                        'doubleValue': 123.0,
                        'stringValue': 'string'
                    }
                },
            ],
            'tags': {
                'string': 'string'
            },
            'templateId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • cases (list) --

      A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.

      • (dict) --

        A list of items that represent cases.

        • caseId (string) --

          A unique identifier of the case.

        • fields (list) --

          List of case field values.

          • (dict) --

            Object for case field values.

            • id (string) --

              Unique identifier of a field.

            • value (dict) --

              Union of potential field value types.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: booleanValue, doubleValue, stringValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              
              • booleanValue (boolean) --

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue (float) --

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue (string) --

                String value type.

        • tags (dict) --

          A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

          • (string) --
            • (string) --
        • templateId (string) --

          A unique identifier of a template.

    • NextToken (string) --

      A token to resume pagination.

class ConnectCases.Paginator.SearchRelatedItems
paginator = client.get_paginator('search_related_items')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectCases.Client.search_related_items().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    caseId='string',
    domainId='string',
    filters=[
        {
            'comment': {}
            ,
            'contact': {
                'channel': [
                    'string',
                ],
                'contactArn': 'string'
            }
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • caseId (string) --

    [REQUIRED]

    A unique identifier of the case.

  • domainId (string) --

    [REQUIRED]

    The unique identifier of the Cases domain.

  • filters (list) --

    The list of types of related items and their parameters to use for filtering.

    • (dict) --

      The list of types of related items and their parameters to use for filtering.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: comment, contact.

      • comment (dict) --

        A filter for related items of type Comment .

      • contact (dict) --

        A filter for related items of type Contact .

        • channel (list) --

          A list of channels to filter on for related items of type Contact .

          • (string) --
        • contactArn (string) --

          A unique identifier of a contact in Amazon Connect.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'relatedItems': [
        {
            'associationTime': datetime(2015, 1, 1),
            'content': {
                'comment': {
                    'body': 'string',
                    'contentType': 'Text/Plain'
                },
                'contact': {
                    'channel': 'string',
                    'connectedToSystemTime': datetime(2015, 1, 1),
                    'contactArn': 'string'
                }
            },
            'relatedItemId': 'string',
            'tags': {
                'string': 'string'
            },
            'type': 'Contact'|'Comment'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • relatedItems (list) --

      A list of items related to a case.

      • (dict) --

        A list of items that represent RelatedItems.

        • associationTime (datetime) --

          Time at which a related item was associated with a case.

        • content (dict) --

          Represents the content of a particular type of related item.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: comment, contact. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • comment (dict) --

            Represents the content of a comment to be returned to agents.

            • body (string) --

              Text in the body of a Comment on a case.

            • contentType (string) --

              Type of the text in the box of a Comment on a case.

          • contact (dict) --

            Represents the content of a contact to be returned to agents.

            • channel (string) --

              A list of channels to filter on for related items of type Contact .

            • connectedToSystemTime (datetime) --

              The difference between the InitiationTimestamp and the DisconnectTimestamp of the contact.

            • contactArn (string) --

              A unique identifier of a contact in Amazon Connect.

        • relatedItemId (string) --

          Unique identifier of a related item.

        • tags (dict) --

          A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

          • (string) --
            • (string) --
        • type (string) --

          Type of a related item.

    • NextToken (string) --

      A token to resume pagination.