Skip to content

Commit

Permalink
docs(client-connect): GetMetricDataV2 API: Channels filters do not co…
Browse files Browse the repository at this point in the history
…unt towards overall limitation of 100 filter values.
  • Loading branch information
awstools committed Jul 5, 2023
1 parent 89f0f5c commit be38fc8
Show file tree
Hide file tree
Showing 17 changed files with 97 additions and 83 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,10 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR

/**
* @public
* <p>Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define
* questions related to agent performance, and create sections to organize such questions. Question and section identifiers
* cannot be duplicated within the same evaluation form.</p>
* <p>Creates an evaluation form in the specified Amazon Connect instance. The form can be
* used to define questions related to agent performance, and create sections to organize such
* questions. Question and section identifiers cannot be duplicated within the same evaluation
* form.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export interface CreateParticipantCommandOutput extends CreateParticipantRespons
/**
* @public
* <p>Adds a new participant into an on-going chat contact. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html">Customize chat
* flow experiences by integrating custom participants</a>.</p>
* flow experiences by integrating custom participants</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
4 changes: 3 additions & 1 deletion clients/client-connect/src/commands/CreatePromptCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ export interface CreatePromptCommandOutput extends CreatePromptResponse, __Metad

/**
* @public
* <p>Creates a prompt. For more information about prompts, such as supported file types and maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Amazon Connect Administrator's Guide</i>.</p>
* <p>Creates a prompt. For more information about prompts, such as supported file types and
* maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Amazon Connect Administrator's
* Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
4 changes: 4 additions & 0 deletions clients/client-connect/src/commands/CreateQueueCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ export interface CreateQueueCommandOutput extends CreateQueueResponse, __Metadat
* in
* this scenario, you will receive a
* <code>ResourceNotFoundException</code>.</p>
* <p>Only use the phone number ARN format that doesn't contain <code>instance</code> in the
* path, for example, <code>arn:aws:connect:us-east-1:1234567890:phone-number/uuid</code>. This is
* the same ARN format that is returned when you call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a>
* API.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ export interface DeleteEvaluationFormCommandOutput extends __MetadataBearer {}
* <p>Deletes an evaluation form in the specified Amazon Connect instance. </p>
* <ul>
* <li>
* <p>If the version
* property is provided, only the specified version of the evaluation form is deleted.</p>
* <p>If the version property is provided, only the specified version of the evaluation form is
* deleted.</p>
* </li>
* <li>
* <p>If no version is provided, then the full form (all versions) is deleted.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ export interface SearchHoursOfOperationsCommandOutput extends SearchHoursOfOpera

/**
* @public
* <p>Searches the hours of operation in an Amazon Connect instance, with optional filtering.</p>
* <p>Searches the hours of operation in an Amazon Connect instance, with optional
* filtering.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 1 addition & 2 deletions clients/client-connect/src/commands/SearchQueuesCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ export interface SearchQueuesCommandOutput extends SearchQueuesResponse, __Metad

/**
* @public
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
* <p>Searches queues in an Amazon Connect instance, with optional filtering.</p>
* <p>Searches queues in an Amazon Connect instance, with optional filtering.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ export interface SearchResourceTagsCommandOutput extends SearchResourceTagsRespo
* <p>The request is not valid.</p>
*
* @throws {@link MaximumResultReturnedException} (client fault)
* <p>Maximum number (1000) of tags have been returned with current request. Consider
* changing request parameters to get more tags.</p>
* <p>Maximum number (1000) of tags have been returned with current request. Consider changing
* request parameters to get more tags.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The specified resource was not found.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ export interface SearchRoutingProfilesCommandOutput extends SearchRoutingProfile

/**
* @public
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
* <p>Searches routing profiles in an Amazon Connect instance, with optional filtering.</p>
* <p>Searches routing profiles in an Amazon Connect instance, with optional filtering.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ export interface SearchSecurityProfilesCommandOutput extends SearchSecurityProfi

/**
* @public
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
* <p>Searches security profiles in an Amazon Connect instance, with optional
* <p>Searches security profiles in an Amazon Connect instance, with optional
* filtering.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,10 @@ export interface SuspendContactRecordingCommandOutput extends SuspendContactReco
/**
* @public
* <p>When a contact is being recorded, this API suspends recording the call or screen. For
* example, you might suspend the call or screen recording while collecting sensitive
* information, such as a credit card number. Then use ResumeContactRecording to restart recording.</p>
* <p>The period of time that the recording is suspended is filled with silence in the final recording.</p>
* example, you might suspend the call or screen recording while collecting sensitive information,
* such as a credit card number. Then use ResumeContactRecording to restart recording.</p>
* <p>The period of time that the recording is suspended is filled with silence in the final
* recording.</p>
* <p>Voice and screen recordings are supported.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,10 @@ export interface UpdateEvaluationFormCommandOutput extends UpdateEvaluationFormR
/**
* @public
* <p>Updates details about a specific evaluation form version in the specified Amazon Connect
* instance. Question and section
* identifiers cannot be duplicated within the same evaluation form.</p>
* <p>This operation does not support partial updates. Instead it does a full update of evaluation form content.</p>
* instance. Question and section identifiers cannot be duplicated within the same evaluation
* form.</p>
* <p>This operation does not support partial updates. Instead it does a full update of evaluation
* form content.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ export interface UpdateQueueOutboundCallerConfigCommandOutput extends __Metadata
* in
* this scenario, you will receive a
* <code>ResourceNotFoundException</code>.</p>
* <p>Only use the phone number ARN format that doesn't contain <code>instance</code> in the
* path, for example, <code>arn:aws:connect:us-east-1:1234567890:phone-number/uuid</code>. This is
* the same ARN format that is returned when you call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a>
* API.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
22 changes: 11 additions & 11 deletions clients/client-connect/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ export interface ActivateEvaluationFormRequest {
EvaluationFormId: string | undefined;

/**
* <p>The version of the evaluation form to activate. If the version property is not provided, the latest version of the
* evaluation form is activated.</p>
* <p>The version of the evaluation form to activate. If the version property is not provided, the
* latest version of the evaluation form is activated.</p>
*/
EvaluationFormVersion: number | undefined;
}
Expand Down Expand Up @@ -1552,10 +1552,10 @@ export interface SingleSelectQuestionRuleCategoryAutomation {
Category: string | undefined;

/**
* <p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>, then the
* option is applied when the contact data includes the category. Similarly, if the condition is
* <code>NOT_PRESENT</code>, then the option is applied when the contact data does not include the
* category.</p>
* <p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>,
* then the option is applied when the contact data includes the category. Similarly, if the
* condition is <code>NOT_PRESENT</code>, then the option is applied when the contact data does not
* include the category.</p>
*/
Condition: SingleSelectQuestionRuleCategoryAutomationCondition | string | undefined;

Expand Down Expand Up @@ -2188,8 +2188,8 @@ export interface ParticipantTokenCredentials {
*/
export interface CreateParticipantResponse {
/**
* <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The participant
* token is valid for the lifetime of a chat participant.</p>
* <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The
* participant token is valid for the lifetime of a chat participant.</p>
*/
ParticipantCredentials?: ParticipantTokenCredentials;

Expand Down Expand Up @@ -4160,9 +4160,9 @@ export interface Contact {
* 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 <code>API</code>,
* 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>
* 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
35 changes: 19 additions & 16 deletions clients/client-connect/src/models/models_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -869,7 +869,8 @@ export interface MetricFilterV2 {
* <p>The key to use for filtering data. </p>
* <p>Valid metric filter keys: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code>.
* These are the same values as the <code>InitiationMethod</code> and <code>DisconnectReason</code>
* in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
* in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator's
* Guide</i>. </p>
*/
MetricFilterKey?: string;

Expand Down Expand Up @@ -993,10 +994,10 @@ export interface GetMetricDataV2Request {
* <li>
* <p>
* <b>Filter values</b>: A maximum of 100 filter values are
* supported in a single request. For example, a <code>GetMetricDataV2</code> request can filter
* by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values.
* <code>VOICE</code>, <code>CHAT</code>, and <code>TASK</code> are valid
* <code>filterValue</code> for the <code>CHANNEL</code> filter key.</p>
* supported in a single request. VOICE, CHAT, and TASK are valid <code>filterValue</code> for the CHANNEL
* filter key. They do not count towards limitation of 100 filter values. For example, a
* GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total
* of 100 filter values, along with 3 channel filters.</p>
* </li>
* </ul>
*/
Expand Down Expand Up @@ -4436,8 +4437,8 @@ export interface SearchQuickConnectsResponse {

/**
* @public
* <p>Maximum number (1000) of tags have been returned with current request. Consider
* changing request parameters to get more tags.</p>
* <p>Maximum number (1000) of tags have been returned with current request. Consider changing
* request parameters to get more tags.</p>
*/
export class MaximumResultReturnedException extends __BaseException {
readonly name: "MaximumResultReturnedException" = "MaximumResultReturnedException";
Expand Down Expand Up @@ -4473,12 +4474,14 @@ export interface TagSearchCondition {
tagValue?: string;

/**
* <p>The type of comparison to be made when evaluating the tag key in tag search condition.</p>
* <p>The type of comparison to be made when evaluating the tag key in tag search
* condition.</p>
*/
tagKeyComparisonType?: StringComparisonType | string;

/**
* <p>The type of comparison to be made when evaluating the tag value in tag search condition.</p>
* <p>The type of comparison to be made when evaluating the tag value in tag search
* condition.</p>
*/
tagValueComparisonType?: StringComparisonType | string;
}
Expand All @@ -4505,14 +4508,14 @@ export interface SearchResourceTagsRequest {
InstanceId: string | undefined;

/**
* <p>The list of resource types to be used to search tags from. If not provided or if any empty list
* is provided, this API will search from all supported resource types.</p>
* <p>The list of resource types to be used to search tags from. If not provided or if any empty
* list is provided, this API will search from all supported resource types.</p>
*/
ResourceTypes?: string[];

/**
* <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;

Expand Down Expand Up @@ -7382,7 +7385,7 @@ export interface HoursOfOperationSearchCriteria {
* <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>, <code>timezone</code>, and <code>resourceID</code>.</p>
* <code>description</code>, <code>timezone</code>, and <code>resourceID</code>.</p>
* </note>
*/
StringCondition?: StringCondition;
Expand All @@ -7407,7 +7410,7 @@ export interface PromptSearchCriteria {
* <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>
* <code>description</code>, and <code>resourceID</code>.</p>
* </note>
*/
StringCondition?: StringCondition;
Expand Down Expand Up @@ -7437,7 +7440,7 @@ export interface QueueSearchCriteria {
* <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>
* <code>description</code>, and <code>resourceID</code>.</p>
* </note>
*/
StringCondition?: StringCondition;
Expand Down
6 changes: 3 additions & 3 deletions clients/client-connect/src/models/models_2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export interface QuickConnectSearchCriteria {
* <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>
* <code>description</code>, and <code>resourceID</code>.</p>
* </note>
*/
StringCondition?: StringCondition;
Expand Down Expand Up @@ -67,7 +67,7 @@ export interface RoutingProfileSearchCriteria {
* <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>
* <code>description</code>, and <code>resourceID</code>.</p>
* </note>
*/
StringCondition?: StringCondition;
Expand Down Expand Up @@ -178,7 +178,7 @@ export interface UserSearchCriteria {
* <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>
* <code>description</code>, and <code>resourceID</code>.</p>
* </note>
*/
StringCondition?: StringCondition;
Expand Down
Loading

0 comments on commit be38fc8

Please sign in to comment.