Skip to content

Commit

Permalink
docs(client-connect): This release updates GetMetricDataV2 API, to su…
Browse files Browse the repository at this point in the history
…pport metric data up-to last 35 days
  • Loading branch information
awstools committed May 11, 2023
1 parent c64a34c commit ed2afc8
Show file tree
Hide file tree
Showing 9 changed files with 28,721 additions and 28,711 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,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 @@ -33,7 +33,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
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,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,7 @@ export interface GetMetricDataV2CommandOutput extends GetMetricDataV2Response, _
* <code>GetMetricDataV2</code> offers more features than <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricData.html">GetMetricData</a>, the previous
* version of this API. It has new metrics, offers filtering at a metric level, and offers the
* ability to filter and group data by channels, queues, routing profiles, agents, and agent
* hierarchy levels. It can retrieve historical data for the last 14 days, in 24-hour
* hierarchy levels. It can retrieve historical data for the last 35 days, in 24-hour
* intervals.</p>
* <p>For a description of the historical metrics that are supported by
* <code>GetMetricDataV2</code> and <code>GetMetricData</code>, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical metrics
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,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 @@ -35,6 +35,10 @@ export interface UpdatePhoneNumberCommandOutput extends UpdatePhoneNumberRespons
* <p>Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to
* another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.</p>
* <important>
* <p>After using this API, you must verify that the phone number is attached to the correct flow
* in the target instance or traffic distribution group. You need to do this because the API switches
* only the phone number to a new instance or traffic distribution group. It doesn't migrate the
* flow configuration of the phone number, too.</p>
* <p>You can call <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html">DescribePhoneNumber</a> API
* to verify the status of a previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html">UpdatePhoneNumber</a>
* operation.</p>
Expand Down
16 changes: 8 additions & 8 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 @@ -1550,10 +1550,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 @@ -2186,8 +2186,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
16 changes: 10 additions & 6 deletions clients/client-connect/src/models/models_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -759,7 +759,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 @@ -802,6 +803,9 @@ export interface ThresholdV2 {
export interface MetricV2 {
/**
* <p>The name of the metric.</p>
* <important>
* <p>This parameter is required. The following Required = No is incorrect.</p>
* </important>
*/
Name?: string;

Expand Down Expand Up @@ -830,7 +834,7 @@ export interface GetMetricDataV2Request {
* <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the
* retrieval of historical metrics data. The time must be before the end time timestamp. The time
* range between the start and end time must be less than 24 hours. The start time cannot be earlier
* than 14 days before the time of the request. Historical metrics are available for 14 days.</p>
* than 35 days before the time of the request. Historical metrics are available for 35 days.</p>
*/
StartTime: Date | undefined;

Expand Down Expand Up @@ -3791,8 +3795,8 @@ export interface ListUsersResponse {
*/
export interface MonitorContactRequest {
/**
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the
* instance.</p>
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
* the instance.</p>
*/
InstanceId: string | undefined;

Expand Down Expand Up @@ -4699,8 +4703,8 @@ export interface StartChatContactRequest {
PersistentChat?: PersistentChat;

/**
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the chat
* starting.</p>
* <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
* chat starting.</p>
* <note>
* <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
* </note>
Expand Down
Loading

0 comments on commit ed2afc8

Please sign in to comment.