ConnectCases / Paginator / SearchRelatedItems
SearchRelatedItems#
- 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' } }, 'performedBy': { 'userArn': '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 setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_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 theDisconnectTimestamp
of the contact.contactArn (string) –
A unique identifier of a contact in Amazon Connect.
performedBy (dict) –
Represents the creator of the related item.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
userArn
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
userArn (string) –
Represents the Amazon Connect ARN of the user.
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.