@aws-sdk/client-connect 3.438.0 → 3.441.0

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

@@ -1,6 +1,72 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
-import { ActionSummary, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Application, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactState, DirectoryType, Distribution, EvaluationAnswerData, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MonitorCapability, PhoneNumberCountryCode, PhoneNumberType, Prompt, Queue, QueueReference, QuickConnect, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueReference, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, UseCaseType, UserPhoneConfig, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
+import { ActionSummary, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Application, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactState, DirectoryType, Distribution, EvaluationAnswerData, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, HierarchyGroupSummary, HierarchyLevel, HoursOfOperation, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MonitorCapability, PhoneNumberCountryCode, PhoneNumberType, Prompt, Queue, QueueReference, QuickConnect, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueReference, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, UseCaseType, UserPhoneConfig, View, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
+/**
+ * @public
+ * <p>Contains information about a hierarchy structure.</p>
+ */
+export interface HierarchyStructure {
+    /**
+     * @public
+     * <p>Information about level one.</p>
+     */
+    LevelOne?: HierarchyLevel;
+    /**
+     * @public
+     * <p>Information about level two.</p>
+     */
+    LevelTwo?: HierarchyLevel;
+    /**
+     * @public
+     * <p>Information about level three.</p>
+     */
+    LevelThree?: HierarchyLevel;
+    /**
+     * @public
+     * <p>Information about level four.</p>
+     */
+    LevelFour?: HierarchyLevel;
+    /**
+     * @public
+     * <p>Information about level five.</p>
+     */
+    LevelFive?: HierarchyLevel;
+}
+/**
+ * @public
+ */
+export interface DescribeUserHierarchyStructureResponse {
+    /**
+     * @public
+     * <p>Information about the hierarchy structure.</p>
+     */
+    HierarchyStructure?: HierarchyStructure;
+}
+/**
+ * @public
+ */
+export interface DescribeViewRequest {
+    /**
+     * @public
+     * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
+     */
+    InstanceId: string | undefined;
+    /**
+     * @public
+     * <p>The ViewId of the view. This must be an ARN for Amazon Web Services managed views.</p>
+     */
+    ViewId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeViewResponse {
+    /**
+     * @public
+     * <p>All view data is contained within the View object.</p>
+     */
+    View?: View;
+}
 /**
  * @public
  */
@@ -1422,10 +1488,10 @@ export interface IntervalDetails {
      * @public
      * <p>
      *             <code>IntervalPeriod</code>: An aggregated grouping applied to request metrics. Valid
-     *     <code>IntervalPeriod</code> values are: <code>FIFTEEN_MIN</code> | <code>THIRTY_MIN</code> |
-     *     <code>HOUR</code> | <code>DAY</code> | <code>WEEK</code> | <code>TOTAL</code>. </p>
+     *    <code>IntervalPeriod</code> values are: <code>FIFTEEN_MIN</code> | <code>THIRTY_MIN</code> |
+     *    <code>HOUR</code> | <code>DAY</code> | <code>WEEK</code> | <code>TOTAL</code>. </p>
      *          <p>For example, if <code>IntervalPeriod</code> is selected <code>THIRTY_MIN</code>,
-     *     <code>StartTime</code> and <code>EndTime</code> differs by 1 day, then Amazon Connect
+     *    <code>StartTime</code> and <code>EndTime</code> differs by 1 day, then Amazon Connect
      *    returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By
      *    default Amazon Connect aggregates results based on the <code>TOTAL</code> interval period. </p>
      *          <p>The following list describes restrictions on <code>StartTime</code> and <code>EndTime</code>
@@ -1434,12 +1500,12 @@ export interface IntervalDetails {
      *             <li>
      *                <p>
      *                   <code>FIFTEEN_MIN</code>: The difference between <code>StartTime</code> and
-     *       <code>EndTime</code> must be less than 3 days.</p>
+     *      <code>EndTime</code> must be less than 3 days.</p>
      *             </li>
      *             <li>
      *                <p>
      *                   <code>THIRTY_MIN</code>: The difference between <code>StartTime</code> and
-     *       <code>EndTime</code> must be less than 3 days.</p>
+     *      <code>EndTime</code> must be less than 3 days.</p>
      *             </li>
      *             <li>
      *                <p>
@@ -2036,7 +2102,7 @@ export interface MetricInterval {
      * @public
      * <p>The timestamp, in UNIX Epoch time format. End time is based on the interval period selected.
      *    For example, If <code>IntervalPeriod</code> is selected <code>THIRTY_MIN</code>,
-     *     <code>StartTime</code> and <code>EndTime</code> in the API request differs by 1 day, then 48
+     *    <code>StartTime</code> and <code>EndTime</code> in the API request differs by 1 day, then 48
      *    results are returned in the response. Each result is aggregated by the 30 minutes period, with
      *    each <code>StartTime</code> and <code>EndTime</code> differing by 30 minutes. </p>
      */
@@ -2104,6 +2170,16 @@ export interface GetPromptFileResponse {
      *    the prompt in S3.</p>
      */
     PromptPresignedUrl?: string;
+    /**
+     * @public
+     * <p>The timestamp when this resource was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * @public
+     * <p>The Amazon Web Services Region where this resource was last modified.</p>
+     */
+    LastModifiedRegion?: string;
 }
 /**
  * @public
@@ -3246,6 +3322,16 @@ export interface HoursOfOperationSummary {
      * <p>The name of the hours of operation.</p>
      */
     Name?: string;
+    /**
+     * @public
+     * <p>The timestamp when this resource was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * @public
+     * <p>The Amazon Web Services Region where this resource was last modified.</p>
+     */
+    LastModifiedRegion?: string;
 }
 /**
  * @public
@@ -3676,10 +3762,20 @@ export interface ListPhoneNumbersResponse {
 export interface ListPhoneNumbersV2Request {
     /**
      * @public
-     * <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If <code>TargetArn</code> input is not provided, this API lists numbers claimed
-     *    to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.</p>
+     * <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both <code>TargetArn</code> and <code>InstanceId</code> input are not
+     *    provided, this API lists numbers claimed to all the Amazon Connect instances belonging to
+     *    your account in the same Amazon Web Services Region as the request.</p>
      */
     TargetArn?: string;
+    /**
+     * @public
+     * <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. 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. If both <code>TargetArn</code> and <code>InstanceId</code> are not provided, this API lists numbers
+     *    claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as
+     *    the request.</p>
+     */
+    InstanceId?: string;
     /**
      * @public
      * <p>The maximum number of results to return per page.</p>
@@ -3740,9 +3836,16 @@ export interface ListPhoneNumbersSummary {
     PhoneNumberType?: PhoneNumberType;
     /**
      * @public
-     * <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.</p>
+     * <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.</p>
      */
     TargetArn?: string;
+    /**
+     * @public
+     * <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. 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>
+     */
+    InstanceId?: string;
 }
 /**
  * @public
@@ -3801,6 +3904,16 @@ export interface PromptSummary {
      * <p>The name of the prompt.</p>
      */
     Name?: string;
+    /**
+     * @public
+     * <p>The timestamp when this resource was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * @public
+     * <p>The Amazon Web Services Region where this resource was last modified.</p>
+     */
+    LastModifiedRegion?: string;
 }
 /**
  * @public
@@ -3869,6 +3982,16 @@ export interface QuickConnectSummary {
      *    prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).</p>
      */
     QuickConnectType?: QuickConnectType;
+    /**
+     * @public
+     * <p>The timestamp when this resource was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * @public
+     * <p>The Amazon Web Services Region where this resource was last modified.</p>
+     */
+    LastModifiedRegion?: string;
 }
 /**
  * @public
@@ -3884,6 +4007,16 @@ export interface ListQueueQuickConnectsResponse {
      * <p>Information about the quick connects.</p>
      */
     QuickConnectSummaryList?: QuickConnectSummary[];
+    /**
+     * @public
+     * <p>The timestamp when this resource was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * @public
+     * <p>The Amazon Web Services Region where this resource was last modified.</p>
+     */
+    LastModifiedRegion?: string;
 }
 /**
  * @public
@@ -3948,6 +4081,16 @@ export interface QueueSummary {
      * <p>The type of queue.</p>
      */
     QueueType?: QueueType;
+    /**
+     * @public
+     * <p>The timestamp when this resource was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * @public
+     * <p>The Amazon Web Services Region where this resource was last modified.</p>
+     */
+    LastModifiedRegion?: string;
 }
 /**
  * @public
@@ -4086,6 +4229,16 @@ export interface ListRoutingProfileQueuesResponse {
      * <p>Information about the routing profiles.</p>
      */
     RoutingProfileQueueConfigSummaryList?: RoutingProfileQueueConfigSummary[];
+    /**
+     * @public
+     * <p>The timestamp when this resource was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * @public
+     * <p>The Amazon Web Services Region where this resource was last modified.</p>
+     */
+    LastModifiedRegion?: string;
 }
 /**
  * @public
@@ -4128,6 +4281,16 @@ export interface RoutingProfileSummary {
      * <p>The name of the routing profile.</p>
      */
     Name?: string;
+    /**
+     * @public
+     * <p>The timestamp when this resource was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * @public
+     * <p>The Amazon Web Services Region where this resource was last modified.</p>
+     */
+    LastModifiedRegion?: string;
 }
 /**
  * @public
@@ -4299,18 +4462,18 @@ export interface ListSecurityKeysResponse {
 export interface ListSecurityProfileApplicationsRequest {
     /**
      * @public
-     * <p>The security profile identifier.</p>
+     * <p>The identifier for the security profle.</p>
      */
     SecurityProfileId: string | undefined;
     /**
      * @public
-     * <p>The instance identifier.</p>
+     * <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>
      */
     InstanceId: string | undefined;
     /**
      * @public
-     * <p>The token for the next set of results. The next set of results can be retrieved by using the
-     *    token value returned in the previous response when making the next request.</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;
     /**
@@ -4326,15 +4489,24 @@ export interface ListSecurityProfileApplicationsResponse {
     /**
      * @public
      * <p>This API is in preview release for Amazon Connect and is subject to change.</p>
-     *          <p>A list of the third party application's metadata.</p>
+     *          <p>A list of the third-party application's metadata.</p>
      */
     Applications?: Application[];
     /**
      * @public
-     * <p>The token for the next set of results. The next set of results can be retrieved by using the
-     *    token value returned in the previous response when making the next request.</p>
+     * <p>If there are additional results, this is the token for the next set of results.</p>
      */
     NextToken?: string;
+    /**
+     * @public
+     * <p>The timestamp when this resource was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * @public
+     * <p>The Amazon Web Services Region where this resource was last modified.</p>
+     */
+    LastModifiedRegion?: string;
 }
 /**
  * @public
@@ -4378,6 +4550,16 @@ export interface ListSecurityProfilePermissionsResponse {
      * <p>If there are additional results, this is the token for the next set of results.</p>
      */
     NextToken?: string;
+    /**
+     * @public
+     * <p>The timestamp when this resource was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * @public
+     * <p>The Amazon Web Services Region where this resource was last modified.</p>
+     */
+    LastModifiedRegion?: string;
 }
 /**
  * @public
@@ -4420,6 +4602,16 @@ export interface SecurityProfileSummary {
      * <p>The name of the security profile.</p>
      */
     Name?: string;
+    /**
+     * @public
+     * <p>The timestamp when this resource was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * @public
+     * <p>The Amazon Web Services Region where this resource was last modified.</p>
+     */
+    LastModifiedRegion?: string;
 }
 /**
  * @public
@@ -4857,6 +5049,16 @@ export interface UserSummary {
      * <p>The Amazon Connect user name of the user account.</p>
      */
     Username?: string;
+    /**
+     * @public
+     * <p>The timestamp when this resource was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * @public
+     * <p>The Amazon Web Services Region where this resource was last modified.</p>
+     */
+    LastModifiedRegion?: string;
 }
 /**
  * @public
@@ -4879,8 +5081,7 @@ export interface ListUsersResponse {
 export interface ListViewsRequest {
     /**
      * @public
-     * <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;
     /**
@@ -4890,8 +5091,8 @@ export interface ListViewsRequest {
     Type?: ViewType;
     /**
      * @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;
     /**
@@ -4928,7 +5129,7 @@ export interface ViewSummary {
     /**
      * @public
      * <p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The
-     *     <code>PUBLISHED</code> status will initiate validation on the content.</p>
+     *    <code>PUBLISHED</code> status will initiate validation on the content.</p>
      */
     Status?: ViewStatus;
     /**
@@ -4948,8 +5149,8 @@ export interface ListViewsResponse {
     ViewsSummaryList?: ViewSummary[];
     /**
      * @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;
 }
@@ -4959,20 +5160,18 @@ export interface ListViewsResponse {
 export interface ListViewVersionsRequest {
     /**
      * @public
-     * <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;
     /**
      * @public
-     * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
-     *    used.</p>
+     * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>
      */
     ViewId: string | undefined;
     /**
      * @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;
     /**
@@ -5033,8 +5232,8 @@ export interface ListViewVersionsResponse {
     ViewVersionSummaryList?: ViewVersionSummary[];
     /**
      * @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;
 }
@@ -5208,9 +5407,16 @@ export interface ResumeContactRecordingResponse {
 export interface SearchAvailablePhoneNumbersRequest {
     /**
      * @public
-     * <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.</p>
+     * <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
+     */
+    TargetArn?: string;
+    /**
+     * @public
+     * <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. 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. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
      */
-    TargetArn: string | undefined;
+    InstanceId?: string;
     /**
      * @public
      * <p>The ISO country code.</p>
@@ -7318,102 +7524,9 @@ export declare const ParticipantTimerType: {
  */
 export type ParticipantTimerType = (typeof ParticipantTimerType)[keyof typeof ParticipantTimerType];
 /**
- * @public
- * @enum
- */
-export declare const ParticipantTimerAction: {
-    readonly Unset: "Unset";
-};
-/**
- * @public
- */
-export type ParticipantTimerAction = (typeof ParticipantTimerAction)[keyof typeof ParticipantTimerAction];
-/**
- * @public
- * <p>The value of the timer. Either the timer action (<code>Unset</code> to delete the timer), or
- *    the duration of the timer in minutes. Only one value can be set.</p>
- *          <p>For more information about how chat timeouts work, see
- *    <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
- */
-export type ParticipantTimerValue = ParticipantTimerValue.ParticipantTimerActionMember | ParticipantTimerValue.ParticipantTimerDurationInMinutesMember | ParticipantTimerValue.$UnknownMember;
-/**
- * @public
- */
-export declare namespace ParticipantTimerValue {
-    /**
-     * @public
-     * <p>The timer action. Currently only one value is allowed: <code>Unset</code>. It deletes a
-     *    timer.</p>
-     */
-    interface ParticipantTimerActionMember {
-        ParticipantTimerAction: ParticipantTimerAction;
-        ParticipantTimerDurationInMinutes?: never;
-        $unknown?: never;
-    }
-    /**
-     * @public
-     * <p>The duration of a timer, in minutes. </p>
-     */
-    interface ParticipantTimerDurationInMinutesMember {
-        ParticipantTimerAction?: never;
-        ParticipantTimerDurationInMinutes: number;
-        $unknown?: never;
-    }
-    /**
-     * @public
-     */
-    interface $UnknownMember {
-        ParticipantTimerAction?: never;
-        ParticipantTimerDurationInMinutes?: never;
-        $unknown: [string, any];
-    }
-    interface Visitor<T> {
-        ParticipantTimerAction: (value: ParticipantTimerAction) => T;
-        ParticipantTimerDurationInMinutes: (value: number) => T;
-        _: (name: string, value: any) => T;
-    }
-    const visit: <T>(value: ParticipantTimerValue, visitor: Visitor<T>) => T;
-}
-/**
- * @public
- * <p>Configuration information for the timer. After the timer configuration is set, it persists
- *    for the duration of the chat. It persists across new contacts in the chain, for example, transfer
- *    contacts.</p>
- *          <p>For more information about how chat timeouts work, see
- *    <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
- */
-export interface ParticipantTimerConfiguration {
-    /**
-     * @public
-     * <p>The role of the participant in the chat conversation.</p>
-     */
-    ParticipantRole: TimerEligibleParticipantRoles | undefined;
-    /**
-     * @public
-     * <p>The type of timer. <code>IDLE</code> indicates the timer applies for considering a human
-     *    chat participant as idle. <code>DISCONNECT_NONCUSTOMER</code> indicates the timer applies to
-     *    automatically disconnecting a chat participant due to idleness.</p>
-     */
-    TimerType: ParticipantTimerType | undefined;
-    /**
-     * @public
-     * <p>The value of the timer. Either the timer action (Unset to delete the timer), or the duration
-     *    of the timer in minutes. Only one value can be set.</p>
-     */
-    TimerValue: ParticipantTimerValue | undefined;
-}
-/**
- * @public
- * <p>Configuration information for the chat participant role.</p>
+ * @internal
  */
-export interface ChatParticipantRoleConfig {
-    /**
-     * @public
-     * <p>A list of participant timers. You can specify any unique combination of role and timer type.
-     *    Duplicate entries error out the request with a 400.</p>
-     */
-    ParticipantTimerConfigList: ParticipantTimerConfiguration[] | undefined;
-}
+export declare const DescribeViewResponseFilterSensitiveLog: (obj: DescribeViewResponse) => any;
 /**
  * @internal
  */