@aws-sdk/client-connect 3.606.0 → 3.608.0

package/dist-types/commands/ListUserProficienciesCommand.d.ts

@@ -1,7 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
-import { ListUserProficienciesRequest, ListUserProficienciesResponse } from "../models/models_1";
+import { ListUserProficienciesRequest, ListUserProficienciesResponse } from "../models/models_2";
 /**
  * @public
  */

package/dist-types/commands/ListUsersCommand.d.ts

@@ -1,7 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
-import { ListUsersRequest, ListUsersResponse } from "../models/models_1";
+import { ListUsersRequest, ListUsersResponse } from "../models/models_2";
 /**
  * @public
  */

package/dist-types/commands/ListViewsCommand.d.ts

@@ -1,8 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
-import { ListViewsRequest } from "../models/models_1";
-import { ListViewsResponse } from "../models/models_2";
+import { ListViewsRequest, ListViewsResponse } from "../models/models_2";
 /**
  * @public
  */

package/dist-types/commands/StartAttachedFileUploadCommand.d.ts

@@ -29,8 +29,7 @@ declare const StartAttachedFileUploadCommand_base: {
 /**
  * <p>Provides a pre-signed Amazon S3 URL in response for uploading your content.</p>
  *          <important>
- *             <p>You may only use this API to upload attachments to a <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html">Connect
- *     Case</a>.</p>
+ *             <p>You may only use this API to upload attachments to an <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html">Amazon Connect Case</a>.</p>
  *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/StartChatContactCommand.d.ts

@@ -46,8 +46,20 @@ declare const StartChatContactCommand_base: {
  *          <p>If you use the <code>ChatDurationInMinutes</code> parameter and receive a 400 error, your
  *    account may not support the ability to configure custom chat durations. For more information,
  *    contact Amazon Web Services Support. </p>
- *          <p>For more information about chat, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat.html">Chat</a> in the <i>Amazon Connect
- *     Administrator Guide</i>.</p>
+ *          <p>For more information about chat, see the following topics in the <i>Amazon Connect
+ *    Administrator Guide</i>: </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html">Concepts: Web and mobile messaging capabilities in Amazon Connect</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>
+ *                </p>
+ *             </li>
+ *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartContactStreamingCommand.d.ts

@@ -30,6 +30,20 @@ declare const StartContactStreamingCommand_base: {
  * <p> Initiates real-time message streaming for a new chat contact.</p>
  *          <p> For more information about message streaming, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html">Enable real-time chat message
  *     streaming</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
+ *          <p>For more information about chat, see the following topics in the <i>Amazon Connect
+ *    Administrator Guide</i>: </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html">Concepts: Web and mobile messaging capabilities in Amazon Connect</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>
+ *                </p>
+ *             </li>
+ *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateAuthenticationProfileCommand.d.ts

@@ -0,0 +1,85 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
+import { UpdateAuthenticationProfileRequest } from "../models/models_2";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateAuthenticationProfileCommand}.
+ */
+export interface UpdateAuthenticationProfileCommandInput extends UpdateAuthenticationProfileRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateAuthenticationProfileCommand}.
+ */
+export interface UpdateAuthenticationProfileCommandOutput extends __MetadataBearer {
+}
+declare const UpdateAuthenticationProfileCommand_base: {
+    new (input: UpdateAuthenticationProfileCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAuthenticationProfileCommandInput, UpdateAuthenticationProfileCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateAuthenticationProfileCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAuthenticationProfileCommandInput, UpdateAuthenticationProfileCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>This API is in preview release for Amazon Connect and is subject to change. To
+ * request access to this API, contact Amazon Web Services Support.</p>
+ *          <p>Updates the selected authentication profile.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConnectClient, UpdateAuthenticationProfileCommand } from "@aws-sdk/client-connect"; // ES Modules import
+ * // const { ConnectClient, UpdateAuthenticationProfileCommand } = require("@aws-sdk/client-connect"); // CommonJS import
+ * const client = new ConnectClient(config);
+ * const input = { // UpdateAuthenticationProfileRequest
+ *   AuthenticationProfileId: "STRING_VALUE", // required
+ *   InstanceId: "STRING_VALUE", // required
+ *   Name: "STRING_VALUE",
+ *   Description: "STRING_VALUE",
+ *   AllowedIps: [ // IpCidrList
+ *     "STRING_VALUE",
+ *   ],
+ *   BlockedIps: [
+ *     "STRING_VALUE",
+ *   ],
+ *   PeriodicSessionDuration: Number("int"),
+ * };
+ * const command = new UpdateAuthenticationProfileCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateAuthenticationProfileCommandInput - {@link UpdateAuthenticationProfileCommandInput}
+ * @returns {@link UpdateAuthenticationProfileCommandOutput}
+ * @see {@link UpdateAuthenticationProfileCommandInput} for command's `input` shape.
+ * @see {@link UpdateAuthenticationProfileCommandOutput} for command's `response` shape.
+ * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>Request processing failed because of an error or failure with the service.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>One or more of the specified parameters are not valid.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request is not valid.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The throttling limit has been exceeded.</p>
+ *
+ * @throws {@link ConnectServiceException}
+ * <p>Base exception class for all service exceptions from Connect service.</p>
+ *
+ * @public
+ */
+export declare class UpdateAuthenticationProfileCommand extends UpdateAuthenticationProfileCommand_base {
+}

package/dist-types/commands/index.d.ts

@@ -69,6 +69,7 @@ export * from "./DeleteViewCommand";
 export * from "./DeleteViewVersionCommand";
 export * from "./DeleteVocabularyCommand";
 export * from "./DescribeAgentStatusCommand";
+export * from "./DescribeAuthenticationProfileCommand";
 export * from "./DescribeContactCommand";
 export * from "./DescribeContactEvaluationCommand";
 export * from "./DescribeContactFlowCommand";
@@ -121,6 +122,7 @@ export * from "./ImportPhoneNumberCommand";
 export * from "./ListAgentStatusesCommand";
 export * from "./ListAnalyticsDataAssociationsCommand";
 export * from "./ListApprovedOriginsCommand";
+export * from "./ListAuthenticationProfilesCommand";
 export * from "./ListBotsCommand";
 export * from "./ListContactEvaluationsCommand";
 export * from "./ListContactFlowModulesCommand";
@@ -203,6 +205,7 @@ export * from "./TransferContactCommand";
 export * from "./UntagContactCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateAgentStatusCommand";
+export * from "./UpdateAuthenticationProfileCommand";
 export * from "./UpdateContactAttributesCommand";
 export * from "./UpdateContactCommand";
 export * from "./UpdateContactEvaluationCommand";

package/dist-types/index.d.ts

@@ -1,5 +1,19 @@
 /**
- * <p>Amazon Connect is a cloud-based contact center solution that you use to set up and
+ * <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Service.html">Amazon Connect
+ *        actions</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Service.html">Amazon Connect
+ *        data types</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>Amazon Connect is a cloud-based contact center solution that you use to set up and
  *    manage a customer contact center and provide reliable customer engagement at any scale.</p>
  *          <p>Amazon Connect provides metrics and real-time reporting that enable you to optimize
  *    contact routing. You can also resolve customer issues more efficiently by getting customers in

package/dist-types/models/models_0.d.ts

@@ -327,7 +327,7 @@ export interface AgentHierarchyGroup {
 /**
  * <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>
+ *      <i>Amazon Connect Administrator Guide</i>.</p>
  * @public
  */
 export interface AgentHierarchyGroups {
@@ -403,7 +403,8 @@ export interface DeviceInfo {
     OperatingSystem?: string;
 }
 /**
- * <p>Information about the agent hierarchy. Hierarchies can be configured with up to five levels.</p>
+ * <p>Information about the agent hierarchy. Hierarchies can be configured with up to five
+ *    levels.</p>
  * @public
  */
 export interface HierarchyGroups {
@@ -481,8 +482,10 @@ export interface AudioQualityMetricsInfo {
      */
     QualityScore?: number;
     /**
-     * <p>List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.</p>
-     *          <p>Valid values: <code>HighPacketLoss</code> | <code>HighRoundTripTime</code> | <code>HighJitterBuffer</code>
+     * <p>List of potential issues causing degradation of quality on a media connection. If the
+     *    service did not detect any potential quality issues the list is empty.</p>
+     *          <p>Valid values: <code>HighPacketLoss</code> | <code>HighRoundTripTime</code> |
+     *     <code>HighJitterBuffer</code>
      *          </p>
      * @public
      */
@@ -499,6 +502,19 @@ export interface AgentQualityMetrics {
      */
     Audio?: AudioQualityMetricsInfo;
 }
+/**
+ * <p>Can be used to define a list of preferred agents to target the contact within the queue.
+ *     Note that agents must have the queue in their routing profile in order to be offered the
+ *     contact.</p>
+ * @public
+ */
+export interface AgentsCriteria {
+    /**
+     * <p>An object to specify a list of agents, by Agent ID.</p>
+     * @public
+     */
+    AgentIds?: string[];
+}
 /**
  * @public
  * @enum
@@ -2048,7 +2064,7 @@ export interface ClaimPhoneNumberResponse {
  */
 export interface CompleteAttachedFileUploadRequest {
     /**
-     * <p>The unique identifier of the Connect instance.</p>
+     * <p>The unique identifier of the Amazon Connect instance.</p>
      * @public
      */
     InstanceId: string | undefined;
@@ -3725,7 +3741,7 @@ export interface FieldValueUnion {
      */
     BooleanValue?: boolean;
     /**
-     * <p>a Double number value type.</p>
+     * <p>A Double number value type.</p>
      * @public
      */
     DoubleValue?: number;
@@ -5691,6 +5707,116 @@ export interface DescribeAgentStatusResponse {
      */
     AgentStatus?: AgentStatus;
 }
+/**
+ * @public
+ */
+export interface DescribeAuthenticationProfileRequest {
+    /**
+     * <p>A unique identifier for the authentication profile. </p>
+     * @public
+     */
+    AuthenticationProfileId: string | undefined;
+    /**
+     * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
+     * @public
+     */
+    InstanceId: string | undefined;
+}
+/**
+ * <p>This API is in preview release for Amazon Connect and is subject to change. To
+ * request access to this API, contact Amazon Web Services Support.</p>
+ *          <p>Information about an authentication profile. An authentication profile is a resource that
+ *    stores the authentication settings for users in your contact center. You use authentication
+ *    profiles to set up IP address range restrictions and session timeouts. For more information, see
+ *    <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html">Set IP address restrictions or session timeouts</a>.
+ *   </p>
+ * @public
+ */
+export interface AuthenticationProfile {
+    /**
+     * <p>A unique identifier for the authentication profile. </p>
+     * @public
+     */
+    Id?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) for the authentication profile.</p>
+     * @public
+     */
+    Arn?: string;
+    /**
+     * <p>The name for the authentication profile.</p>
+     * @public
+     */
+    Name?: string;
+    /**
+     * <p>The description for the authentication profile.</p>
+     * @public
+     */
+    Description?: string;
+    /**
+     * <p>A list of IP address range strings that are allowed to access the Amazon Connect
+     *    instance. For more information about how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure
+     *     IP address based access control</a> in the <i>Amazon Connect Administrator
+     *     Guide</i>.</p>
+     * @public
+     */
+    AllowedIps?: string[];
+    /**
+     * <p>A list of IP address range strings that are blocked from accessing the Amazon Connect
+     *    instance. For more information about how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure
+     *     IP address based access control</a> in the <i>Amazon Connect Administrator
+     *     Guide</i>.</p>
+     * @public
+     */
+    BlockedIps?: string[];
+    /**
+     * <p>Shows whether the authentication profile is the default authentication profile for the
+     *     Amazon Connect instance. The default authentication profile applies to all agents in an
+     *     Amazon Connect instance, unless overridden by another authentication profile.</p>
+     * @public
+     */
+    IsDefault?: boolean;
+    /**
+     * <p>The timestamp when the authentication profile was created.</p>
+     * @public
+     */
+    CreatedTime?: Date;
+    /**
+     * <p>The timestamp when the authentication profile was last modified.</p>
+     * @public
+     */
+    LastModifiedTime?: Date;
+    /**
+     * <p>The Amazon Web Services Region where the authentication profile was last modified.</p>
+     * @public
+     */
+    LastModifiedRegion?: string;
+    /**
+     * <p>The short lived session duration configuration for users logged in to Amazon Connect, in
+     *    minutes. This value determines the maximum possible time before an agent is authenticated. For
+     *    more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure the session duration</a> in the <i>Amazon Connect Administrator
+     *     Guide</i>.</p>
+     * @public
+     */
+    PeriodicSessionDuration?: number;
+    /**
+     * <p>The long lived session duration for users logged in to Amazon Connect, in minutes. After
+     *    this time period, users must log in again. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure the session duration</a> in the <i>Amazon Connect Administrator
+     *     Guide</i>.</p>
+     * @public
+     */
+    MaxSessionDuration?: number;
+}
+/**
+ * @public
+ */
+export interface DescribeAuthenticationProfileResponse {
+    /**
+     * <p>The authentication profile object being described.</p>
+     * @public
+     */
+    AuthenticationProfile?: AuthenticationProfile;
+}
 /**
  * @public
  */
@@ -5753,7 +5879,8 @@ export interface Customer {
  */
 export interface CustomerVoiceActivity {
     /**
-     * <p>Timestamp that measures the beginning of the customer greeting from an outbound voice call.</p>
+     * <p>Timestamp that measures the beginning of the customer greeting from an outbound voice
+     *    call.</p>
      * @public
      */
     GreetingStartTimestamp?: Date;
@@ -5769,7 +5896,8 @@ export interface CustomerVoiceActivity {
  */
 export interface DisconnectDetails {
     /**
-     * <p>Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.</p>
+     * <p>Indicates the potential disconnection issues for a call. This field is not populated if the
+     *    service does not detect potential issues.</p>
      * @public
      */
     PotentialDisconnectIssue?: string;
@@ -5833,6 +5961,17 @@ export interface Expiry {
      */
     ExpiryTimestamp?: Date;
 }
+/**
+ * <p>An object to define <code>AgentsCriteria</code>.</p>
+ * @public
+ */
+export interface MatchCriteria {
+    /**
+     * <p>An object to define <code>AgentIds</code>.</p>
+     * @public
+     */
+    AgentsCriteria?: AgentsCriteria;
+}
 /**
  * <p>An object to specify the predefined attribute condition.</p>
  * @public
@@ -5853,6 +5992,11 @@ export interface AttributeCondition {
      * @public
      */
     ProficiencyLevel?: number;
+    /**
+     * <p>An object to define <code>AgentsCriteria</code>.</p>
+     * @public
+     */
+    MatchCriteria?: MatchCriteria;
     /**
      * <p>The operator of the condition.</p>
      * @public
@@ -5984,139 +6128,6 @@ export interface EvaluationAnswerOutput {
      */
     SystemSuggestedValue?: EvaluationAnswerData;
 }
-/**
- * <p>Information about scores of a contact evaluation item (section or question).</p>
- * @public
- */
-export interface EvaluationScore {
-    /**
-     * <p>The score percentage for an item in a contact evaluation.</p>
-     * @public
-     */
-    Percentage?: number;
-    /**
-     * <p>The flag to mark the item as not applicable for scoring.</p>
-     * @public
-     */
-    NotApplicable?: boolean;
-    /**
-     * <p>The flag that marks the item as automatic fail. If the item or a child item gets an
-     *    automatic fail answer, this flag will be true.</p>
-     * @public
-     */
-    AutomaticFail?: boolean;
-}
-/**
- * <p>Metadata information about a contact evaluation.</p>
- * @public
- */
-export interface EvaluationMetadata {
-    /**
-     * <p>The identifier of the contact in this instance of Amazon Connect. </p>
-     * @public
-     */
-    ContactId: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation.</p>
-     * @public
-     */
-    EvaluatorArn: string | undefined;
-    /**
-     * <p>The identifier of the agent who performed the contact.</p>
-     * @public
-     */
-    ContactAgentId?: string;
-    /**
-     * <p>The overall score of the contact evaluation.</p>
-     * @public
-     */
-    Score?: EvaluationScore;
-}
-/**
- * <p>Information about notes for a contact evaluation.</p>
- * @public
- */
-export interface EvaluationNote {
-    /**
-     * <p>The note for an item (section or question) in a contact evaluation.</p>
-     *          <note>
-     *             <p>Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the
-     *     total number of chars for all the notes in the evaluation combined. Assuming there are N
-     *     questions in the evaluation being submitted, then the max char limit for all notes combined is N
-     *     x 1024.</p>
-     *          </note>
-     * @public
-     */
-    Value?: string;
-}
-/**
- * @public
- * @enum
- */
-export declare const EvaluationStatus: {
-    readonly DRAFT: "DRAFT";
-    readonly SUBMITTED: "SUBMITTED";
-};
-/**
- * @public
- */
-export type EvaluationStatus = (typeof EvaluationStatus)[keyof typeof EvaluationStatus];
-/**
- * <p>Information about a contact evaluation.</p>
- * @public
- */
-export interface Evaluation {
-    /**
-     * <p>A unique identifier for the contact evaluation.</p>
-     * @public
-     */
-    EvaluationId: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
-     * @public
-     */
-    EvaluationArn: string | undefined;
-    /**
-     * <p>Metadata about the contact evaluation.</p>
-     * @public
-     */
-    Metadata: EvaluationMetadata | undefined;
-    /**
-     * <p>A map of question identifiers to answer value.</p>
-     * @public
-     */
-    Answers: Record<string, EvaluationAnswerOutput> | undefined;
-    /**
-     * <p>A map of question identifiers to note value.</p>
-     * @public
-     */
-    Notes: Record<string, EvaluationNote> | undefined;
-    /**
-     * <p>The status of the contact evaluation.</p>
-     * @public
-     */
-    Status: EvaluationStatus | undefined;
-    /**
-     * <p>A map of item (section or question) identifiers to score value.</p>
-     * @public
-     */
-    Scores?: Record<string, EvaluationScore>;
-    /**
-     * <p>The timestamp for when the evaluation was created.</p>
-     * @public
-     */
-    CreatedTime: Date | undefined;
-    /**
-     * <p>The timestamp for when the evaluation was last updated.</p>
-     * @public
-     */
-    LastModifiedTime: Date | undefined;
-    /**
-     * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
-     * @public
-     */
-    Tags?: Record<string, string>;
-}
 /**
  * @internal
  */