Skip to content

Commit

Permalink
feat(client-connect): Amazon Connect, Contact Lens Evaluation API inc…
Browse files Browse the repository at this point in the history 
…rease evaluation notes max length to 3072.
  • Loading branch information
awstools committed Jan 3, 2024
1 parent 04c1459 commit a0b0198
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 68 deletions.
4 changes: 3 additions & 1 deletion clients/client-connect/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,9 @@ export interface AgentContactReference {

/**
* @public
* <p>A structure that defines agent hierarchy group levels which can be used to filter search results. Important: Agent hierarchy group level information in search result is a snapshot, it does not represent current agent hierarchy who handled the contact.</p>
* <p>A structure that defines search criteria for contacts using agent hierarchy group levels.
* For more information about agent hierarchies, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html">Set Up Agent Hierarchies</a> in the
* <i>Amazon Connect Administrator Guide</i>.</p>
*/
export interface AgentHierarchyGroups {
/**
Expand Down
60 changes: 38 additions & 22 deletions clients/client-connect/src/models/models_1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8923,7 +8923,8 @@ export type SearchContactsMatchType = (typeof SearchContactsMatchType)[keyof typ

/**
* @public
* <p>The transcript criteria used to search</p>
* <p>A structure that defines search criteria base on words or phrases, participants in the
* Contact Lens conversational analytics transcript.</p>
*/
export interface TranscriptCriteria {
/**
Expand All @@ -8940,121 +8941,136 @@ export interface TranscriptCriteria {

/**
* @public
* <p>The match type of search texts in a transcript criteria.</p>
* <p>The match type combining search criteria using multiple search texts in a transcript
* criteria.</p>
*/
MatchType: SearchContactsMatchType | undefined;
}

/**
* @public
* <p>The transcript object used to search results.</p>
* <p>A structure that defines search criteria and matching logic to search for contacts by
* matching text with transcripts analyzed by Amazon Connect Contact Lens.</p>
*/
export interface Transcript {
/**
* @public
* <p>The array of transcript search criteria</p>
* <p>The list of search criteria based on Contact Lens conversational analytics
* transcript.</p>
*/
Criteria: TranscriptCriteria[] | undefined;

/**
* @public
* <p>The match type of multiple transcript criteira</p>
* <p>The match type combining search criteria using multiple transcript criteria.</p>
*/
MatchType?: SearchContactsMatchType;
}

/**
* @public
* <p>A structure that defines filters can be used to search within outputs analyzed by Amazon Connect Contact Lens in a contact.</p>
* <p>A structure that defines search criteria for contacts using analysis outputs from Amazon
* Connect Contact Lens.</p>
*/
export interface ContactAnalysis {
/**
* @public
* <p>A structure that defines filters can be used to search with text within an Amazon Connect Contact Lens analyzed transcript.</p>
* <p>Search criteria based on transcript analyzed by Amazon Connect Contact Lens.</p>
*/
Transcript?: Transcript;
}

/**
* @public
* <p>The criteria of searchable contact attributes.</p>
* <p>The search criteria based on user-defned contact attribute key and values to search
* on.</p>
*/
export interface SearchableContactAttributesCriteria {
/**
* @public
* <p>The searchable contact attribute key</p>
* <p>The key containing a searchable user-defined contact attribute.</p>
*/
Key: string | undefined;

/**
* @public
* <p>The array of contact attribute values used to filter search results.</p>
* <p>The list of values to search for within a user-defined contact attribute.</p>
*/
Values: string[] | undefined;
}

/**
* @public
* <p>A structure that defines searchable contact attributes which can be used to filter search results. </p>
* <p>A structure that defines search criteria based on user-defined contact attributes that are
* configured for contact search.</p>
*/
export interface SearchableContactAttributes {
/**
* @public
* <p>The array of searhale contact attribute criteria</p>
* <p>The list of criteria based on user-defined contact attributes that are configured for
* contact search.</p>
*/
Criteria: SearchableContactAttributesCriteria[] | undefined;

/**
* @public
* <p>The match type of multiple searchable contact attributes criteria.</p>
* <p>The match type combining search criteria using multiple searchable contact
* attributes.</p>
*/
MatchType?: SearchContactsMatchType;
}

/**
* @public
* <p>A structure of search criteria to be used to return contacts</p>
* <p>A structure of search criteria to be used to return contacts.</p>
*/
export interface SearchCriteria {
/**
* @public
* <p>The array of agent ids</p>
* <p>The identifiers of agents who handled the contacts.</p>
*/
AgentIds?: string[];

/**
* @public
* <p>The agent hierarchy groups</p>
* <p>The agent hierarchy groups of the agent at the time of handling the contact.</p>
*/
AgentHierarchyGroups?: AgentHierarchyGroups;

/**
* @public
* <p>The array of channels</p>
* <p>The list of channels associated with contacts.</p>
*/
Channels?: Channel[];

/**
* @public
* <p>The ContactAnalysis object used in search criteria</p>
* <p>Search criteria based on analysis outputs from Amazon Connect Contact Lens.</p>
*/
ContactAnalysis?: ContactAnalysis;

/**
* @public
* <p>The array of initiaton methods</p>
* <p>The list of initiation methods associated with contacts.</p>
*/
InitiationMethods?: ContactInitiationMethod[];

/**
* @public
* <p>The array of queue ids.</p>
* <p>The list of queue IDs associated with contacts.</p>
*/
QueueIds?: string[];

/**
* @public
* <p>The SearchableContactAttributes object used in search criteria</p>
* <p>The search criteria based on user-defined contact attributes that have been configured for
* contact search. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/search-custom-attributes.html">Search by customer contact
* attributes</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
* <important>
* <p>To use <code>SearchableContactAttributes</code> in a search request, the
* <code>GetContactAttributes</code> action is required to perform an API request. For more
* information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions">https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions</a>Actions defined by Amazon Connect.</p>
* </important>
*/
SearchableContactAttributes?: SearchableContactAttributes;
}
Expand All @@ -9079,7 +9095,7 @@ export type SortableFieldName = (typeof SortableFieldName)[keyof typeof Sortable

/**
* @public
* <p>A structure that defines the sort by and a sort order</p>
* <p>A structure that defineds the field name to sort by and a sort order.</p>
*/
export interface Sort {
/**
Expand Down
32 changes: 20 additions & 12 deletions clients/client-connect/src/models/models_2.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,12 +82,12 @@ export type SearchContactsTimeRangeType =

/**
* @public
* <p>A structure of time range that you want to search results</p>
* <p>A structure of time range that you want to search results.</p>
*/
export interface SearchContactsTimeRange {
/**
* @public
* <p>The type of timestamp to search</p>
* <p>The type of timestamp to search.</p>
*/
Type: SearchContactsTimeRangeType | undefined;

Expand All @@ -110,13 +110,14 @@ export interface SearchContactsTimeRange {
export interface SearchContactsRequest {
/**
* @public
* <p>The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance</p>
* <p>The identifier of Amazon Connect instance. You can find the instance ID in the Amazon
* Resource Name (ARN) of the instance.</p>
*/
InstanceId: string | undefined;

/**
* @public
* <p>Time range that you want to search results</p>
* <p>Time range that you want to search results.</p>
*/
TimeRange: SearchContactsTimeRange | undefined;

Expand All @@ -134,13 +135,14 @@ export interface SearchContactsRequest {

/**
* @public
* <p>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.</p>
* <p>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.</p>
*/
NextToken?: string;

/**
* @public
* <p>Specifies a field to sort by and a sort order</p>
* <p>Specifies a field to sort by and a sort order.</p>
*/
Sort?: Sort;
}
Expand Down Expand Up @@ -188,7 +190,7 @@ export interface ContactSearchSummaryQueueInfo {
export interface ContactSearchSummary {
/**
* @public
* <p>The Amazon Resource Name (ARN) of the contact</p>
* <p>The Amazon Resource Name (ARN) of the contact.</p>
*/
Arn?: string;

Expand Down Expand Up @@ -236,7 +238,13 @@ export interface ContactSearchSummary {

/**
* @public
* <p>The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.</p>
* <p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is
* when the contact arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For
* <code>CALLBACK</code>, this is when the callback contact was created. For <code>TRANSFER</code>
* and <code>QUEUE_TRANSFER</code>, this is when the transfer was initiated. For API, this is when
* the request arrived. For <code>EXTERNAL_OUTBOUND</code>, this is when the agent started dialing
* the external participant. For <code>MONITOR</code>, this is when the supervisor started listening
* to a contact.</p>
*/
InitiationTimestamp?: Date;

Expand Down Expand Up @@ -5032,10 +5040,10 @@ export interface UserSearchCriteria {
/**
* @public
* <p>A leaf node condition which can be used to specify a string condition.</p>
* <note>
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
* <code>description</code>, and <code>resourceID</code>.</p>
* </note>
* <p>The currently supported values for <code>FieldName</code> are <code>username</code>,
* <code>firstname</code>, <code>lastname</code>, <code>resourceId</code>,
* <code>routingProfileId</code>, <code>securityProfileId</code>, <code>agentGroupId</code>, and
* <code>agentGroupPathIds</code>.</p>
*/
StringCondition?: StringCondition;

Expand Down
Loading

0 comments on commit a0b0198

Please sign in to comment.