@cdklabs/cdk-construct-connect-datalake 0.0.25 → 0.0.27

package/node_modules/@aws-sdk/client-connect/dist-types/models/models_2.d.ts

@@ -1,6 +1,160 @@
-import type { AgentStatusType, ArtifactStatus, AttachmentScope, AutoEvaluationStatus, BooleanComparisonType, Channel, Comparison, ContactFlowModuleState, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactRecordingType, ContactState, DataTableAttributeValueType, DateTimeComparisonType, DirectoryType, EntityType, EvaluationFormValidationFindingSeverity, EvaluationFormValidationStatus, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, EventSourceName, ExecutionRecordStatus, FilterV2StringConditionComparisonOperator, FlowAssociationResourceType, Grouping, HistoricalMetricName, InstanceStatus, InstanceStorageResourceType, IntegrationType, IntervalPeriod, LexVersion, ListFlowAssociationResourceType, LocaleCode, MediaType, MetricStatus, MetricType, MonitorCapability, NotificationPriority, NotificationSource, NotificationStatus, OperationalStatus, ParticipantRole, PhoneNumberCountryCode, PhoneNumberType, QueueType, QuickConnectType, RealTimeContactAnalysisExtractedInformationFailureCode, RealTimeContactAnalysisOutputType, RealTimeContactAnalysisPostContactSummaryFailureCode, RealTimeContactAnalysisPostContactSummaryStatus, RealTimeContactAnalysisSegmentType, RealTimeContactAnalysisSentimentLabel, RealTimeContactAnalysisStatus, RealTimeContactAnalysisSupportedChannel, ReferenceStatus, ReferenceType, RuleCapabilityTier, RulePublishStatus, SourceType, Statistic, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, ViewStatus, ViewType, VocabularyLanguageCode } from "./enums";
-import type { ActionSummary, AgentConfig, AgentContactReference, AgentStatus, AgentStatusIdentifier, AgentStatusReference, AgentStatusSummary, AnalyticsDataAssociationResult, Application, DataTableLockVersion, Distribution, FlowAssociationSummary, FlowModule, InstanceStorageConfig, LexBot, LexV2Bot, OverrideTimeSlice, PrimaryValueResponse, QueueReference, SecurityProfileItem, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, UserProficiency } from "./models_0";
-import type { Attribute, CurrentMetric, CurrentMetricSortCriteria, DataTableAttribute, EvaluationContactParticipant, EvaluationScore, ExtensionConfiguration, Filters, HierarchyGroupSummary, HoursOfOperationOverride, HoursOfOperationsIdentifier, Notification } from "./models_1";
+import type { AgentStatusType, ArtifactStatus, AttachmentScope, AutoEvaluationStatus, Channel, Comparison, ContactFlowModuleState, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactMetricName, ContactState, CurrentMetricName, DataTableAttributeValueType, DirectoryType, EntityType, EvaluationFormAIVersionStatus, EvaluationFormValidationFindingSeverity, EvaluationFormValidationStatus, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, EventSourceName, ExecutionRecordStatus, FilterV2StringConditionComparisonOperator, FlowAssociationResourceType, Grouping, HistoricalMetricName, InstanceStatus, InstanceStorageResourceType, IntegrationType, IntervalPeriod, LexVersion, ListFlowAssociationResourceType, LocaleCode, MediaType, MetricStatus, MetricType, MonitorCapability, NotificationPriority, NotificationSource, NotificationStatus, OperationalStatus, ParticipantRole, PhoneNumberCountryCode, PhoneNumberType, QueueType, QuickConnectType, RealTimeContactAnalysisExtractedInformationFailureCode, RealTimeContactAnalysisOutputType, RealTimeContactAnalysisPostContactSummaryFailureCode, RealTimeContactAnalysisPostContactSummaryStatus, RealTimeContactAnalysisSegmentType, RealTimeContactAnalysisSentimentLabel, RealTimeContactAnalysisStatus, RealTimeContactAnalysisSupportedChannel, ReferenceStatus, ReferenceType, RuleCapabilityTier, RulePublishStatus, SortOrder, SourceType, Statistic, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, ViewStatus, ViewType, VocabularyLanguageCode } from "./enums";
+import type { ActionSummary, AgentConfig, AgentContactReference, AgentStatusIdentifier, AgentStatusReference, AgentStatusSummary, AnalyticsDataAssociationResult, Application, DataTableLockVersion, Distribution, FlowAssociationSummary, FlowModule, InstanceStorageConfig, LexBot, LexV2Bot, OverrideTimeSlice, PrimaryValueResponse, QueueReference, SecurityProfileItem, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, UserProficiency } from "./models_0";
+import type { Attribute, ContactMetricValue, DataTableAttribute, EvaluationContactParticipant, EvaluationScore, ExtensionConfiguration, HierarchyGroupSummary, HoursOfOperationOverride, HoursOfOperationsIdentifier, Notification } from "./models_1";
+/**
+ * <p>Contains the result of a requested metric for the contact. This object is returned as part of the
+ *    GetContactMetrics response and includes both the metric name and its calculated value.</p>
+ * @public
+ */
+export interface ContactMetricResult {
+    /**
+     * <p>The name of the metric that was retrieved. This corresponds to the metric name specified in the
+     *    request, such as POSITION_IN_QUEUE or ESTIMATED_WAIT_TIME.</p>
+     * @public
+     */
+    Name: ContactMetricName | undefined;
+    /**
+     * <p>The calculated value for the requested metric. This object contains the numeric result based on
+     *    the contact's current state in the queue.</p>
+     * @public
+     */
+    Value: ContactMetricValue | undefined;
+}
+/**
+ * @public
+ */
+export interface GetContactMetricsResponse {
+    /**
+     * <p>A list of metric results containing the calculated values for each requested metric. Each result includes
+     *    the metric name and its corresponding value. For example, POSITION_IN_QUEUE returns a numeric value representing
+     *    the contact's position in queue, and ESTIMATED_WAIT_TIME returns the predicted wait time in seconds.</p>
+     * @public
+     */
+    MetricResults?: ContactMetricResult[] | undefined;
+    /**
+     * <p>The unique identifier of the contact for which metrics were retrieved. This matches the ContactId provided
+     *    in the request.</p>
+     * @public
+     */
+    Id?: string | undefined;
+    /**
+     * <p>The ARN of the contact for which metrics were retrieved.</p>
+     * @public
+     */
+    Arn?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetCrossRegionRoutingRequest {
+    /**
+     * <p>The identifier of the Connect Customer 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;
+}
+/**
+ * @public
+ */
+export interface GetCrossRegionRoutingResponse {
+    /**
+     * <p>The list of Regions for which cross-region routing is currently disabled (isolated). When a Region
+     *    appears in this list, contacts originating in that Region will not be routed to agents in other Regions,
+     *    and agents in that Region will not receive contacts from other Regions.</p>
+     * @public
+     */
+    IsolatedRegions?: string[] | undefined;
+}
+/**
+ * <p>Contains information about a real-time metric. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definitions</a> in the <i>Connect Customer Administrator Guide</i>.</p>
+ *          <important>
+ *             <p>Only one of either the Name or MetricId is required.</p>
+ *          </important>
+ * @public
+ */
+export interface CurrentMetric {
+    /**
+     * <p>The name of the metric.</p>
+     * @public
+     */
+    Name?: CurrentMetricName | undefined;
+    /**
+     * <p>Out of the box current metrics or custom metrics can be referenced via this field. This field is a valid AWS Connect Arn or a UUID.</p>
+     * @public
+     */
+    MetricId?: string | undefined;
+    /**
+     * <note>
+     *             <p>The Unit parameter is not supported for custom metrics.</p>
+     *          </note>
+     *          <p>The unit for the metric.</p>
+     * @public
+     */
+    Unit?: Unit | undefined;
+}
+/**
+ * <p>Contains the filter to apply when retrieving metrics.</p>
+ * @public
+ */
+export interface Filters {
+    /**
+     * <p>The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues
+     *    per request. The <code>GetCurrentMetricsData</code> API in particular requires a queue when you include a
+     *     <code>Filter</code> in your request. </p>
+     * @public
+     */
+    Queues?: string[] | undefined;
+    /**
+     * <p>The channel to use to filter the metrics.</p>
+     * @public
+     */
+    Channels?: Channel[] | undefined;
+    /**
+     * <p>A list of up to 100 routing profile IDs or ARNs.</p>
+     * @public
+     */
+    RoutingProfiles?: string[] | undefined;
+    /**
+     * <p>A list of expressions as a filter, in which an expression is an object of a step in a routing
+     *    criteria. Accepts filter values up to 3,000 characters in length. Filter values are case-sensitive.
+     *    JSON object key order and whitespace may be arbitrary; array order and tree structure must be preserved.</p>
+     * @public
+     */
+    RoutingStepExpressions?: string[] | undefined;
+    /**
+     * <p>A list of up to 50 agent status IDs or ARNs.</p>
+     * @public
+     */
+    AgentStatuses?: string[] | undefined;
+    /**
+     * <p>A list of up to 10 subtypes can be provided.</p>
+     * @public
+     */
+    Subtypes?: string[] | undefined;
+    /**
+     * <p>A list of up to 10 validationTestTypes can be provided.</p>
+     * @public
+     */
+    ValidationTestTypes?: string[] | undefined;
+}
+/**
+ * <p>The way to sort the resulting response based on metrics. By default resources are sorted based on
+ *     <code>AGENTS_ONLINE</code>, <code>DESCENDING</code>. The metric collection is sorted based on the input
+ *    metrics.</p>
+ * @public
+ */
+export interface CurrentMetricSortCriteria {
+    /**
+     * <p>The current metric names.</p>
+     * @public
+     */
+    SortByMetric?: CurrentMetricName | undefined;
+    /**
+     * <p>The way to sort.</p>
+     * @public
+     */
+    SortOrder?: SortOrder | undefined;
+}
 /**
  * @public
  */
@@ -5651,6 +5805,106 @@ export interface ListEntitySecurityProfilesResponse {
      */
     NextToken?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface ListEvaluationFormAIVersionsRequest {
+    /**
+     * <p>The identifier of the Connect Customer 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>The contact interaction type for the evaluation form.</p>
+     * @public
+     */
+    ContactInteractionType: ContactInteractionType | undefined;
+    /**
+     * <p>The maximum number of results to return per page.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+    /**
+     * <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>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * <p>Contains the status and availability dates for an AI version, indicating when the version became active and when it reaches end of life.</p>
+ * @public
+ */
+export interface EvaluationFormAIVersionLifecycle {
+    /**
+     * <p>The status of the AI version. Valid values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>Latest</code> - The most recent AI version.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>Preview</code> - An AI version available for preview.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>Active</code> - An AI version that is currently available.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>Deprecated</code> - An AI version that is no longer recommended for use.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>Removed</code> - An AI version that is no longer available.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    Status: EvaluationFormAIVersionStatus | undefined;
+    /**
+     * <p>The timestamp for when this AI version became available.</p>
+     * @public
+     */
+    StartOfLifeTime: Date | undefined;
+    /**
+     * <p>The timestamp when this AI version reaches or reached end of life.</p>
+     * @public
+     */
+    EndOfLifeTime?: Date | undefined;
+}
+/**
+ * <p>Contains the name and lifecycle information for an AI version that you can use when creating or updating an evaluation form.</p>
+ * @public
+ */
+export interface EvaluationFormAIVersionSummary {
+    /**
+     * <p>The name of the AI version.</p>
+     * @public
+     */
+    AIVersionName: string | undefined;
+    /**
+     * <p>The lifecycle information for this AI version, including its status and availability dates.</p>
+     * @public
+     */
+    AIVersionLifecycle: EvaluationFormAIVersionLifecycle | undefined;
+}
+/**
+ * @public
+ */
+export interface ListEvaluationFormAIVersionsResponse {
+    /**
+     * <p>The list of AI version summaries.</p>
+     * @public
+     */
+    AIVersionSummaries: EvaluationFormAIVersionSummary[] | undefined;
+    /**
+     * <p>If there are additional results, this is the token for the next set of results.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
 /**
  * @public
  */
@@ -8777,7 +9031,7 @@ export interface TrafficDistributionGroupSummary {
      */
     Name?: string | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
+     * <p>The Amazon Resource Name (ARN) of the instance.</p>
      * @public
      */
     InstanceArn?: string | undefined;
@@ -9693,217 +9947,3 @@ export interface ReplicateInstanceRequest {
      */
     ReplicaAlias: string | undefined;
 }
-/**
- * @public
- */
-export interface ReplicateInstanceResponse {
-    /**
-     * <p>The identifier of the replicated instance. You can find the <code>instanceId</code> in the ARN of the instance.
-     *    The replicated instance has the same identifier as the instance it was replicated from.</p>
-     * @public
-     */
-    Id?: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the replicated instance.</p>
-     * @public
-     */
-    Arn?: string | undefined;
-}
-/**
- * @public
- */
-export interface ResumeContactRequest {
-    /**
-     * <p>The identifier of the contact.</p>
-     * @public
-     */
-    ContactId: string | undefined;
-    /**
-     * <p>The identifier of the Connect Customer instance. You can find the <code>instanceId</code> in the ARN of the
-     *    instance.</p>
-     * @public
-     */
-    InstanceId: string | undefined;
-    /**
-     * <p>The identifier of the flow.</p>
-     * @public
-     */
-    ContactFlowId?: string | undefined;
-}
-/**
- * @public
- */
-export interface ResumeContactResponse {
-}
-/**
- * @public
- */
-export interface ResumeContactRecordingRequest {
-    /**
-     * <p>The identifier of the Connect Customer 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>The identifier of the contact.</p>
-     * @public
-     */
-    ContactId: string | undefined;
-    /**
-     * <p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with
-     *    the contact center.</p>
-     * @public
-     */
-    InitialContactId: string | undefined;
-    /**
-     * <p>The type of recording being operated on.</p>
-     * @public
-     */
-    ContactRecordingType?: ContactRecordingType | undefined;
-}
-/**
- * @public
- */
-export interface ResumeContactRecordingResponse {
-}
-/**
- * @public
- */
-export interface SearchAgentStatusesResponse {
-    /**
-     * <p>The search criteria to be used to return agent statuses.</p>
-     * @public
-     */
-    AgentStatuses?: AgentStatus[] | undefined;
-    /**
-     * <p>If there are additional results, this is the token for the next set of results.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-    /**
-     * <p>The total number of agent statuses which matched your search query.</p>
-     * @public
-     */
-    ApproximateTotalCount?: number | undefined;
-}
-/**
- * @public
- */
-export interface SearchAvailablePhoneNumbersRequest {
-    /**
-     * <p>The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
-     * @public
-     */
-    TargetArn?: string | undefined;
-    /**
-     * <p>The identifier of the Connect Customer 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>
-     * @public
-     */
-    InstanceId?: string | undefined;
-    /**
-     * <p>The ISO country code.</p>
-     * @public
-     */
-    PhoneNumberCountryCode: PhoneNumberCountryCode | undefined;
-    /**
-     * <p>The type of phone number.</p>
-     * @public
-     */
-    PhoneNumberType: PhoneNumberType | undefined;
-    /**
-     * <p>The prefix of the phone number. If provided, it must contain <code>+</code> as part of the country code.</p>
-     * @public
-     */
-    PhoneNumberPrefix?: string | undefined;
-    /**
-     * <p>The maximum number of results to return per page.</p>
-     * @public
-     */
-    MaxResults?: number | undefined;
-    /**
-     * <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>
-     * @public
-     */
-    NextToken?: string | undefined;
-}
-/**
- * <p>Information about available phone numbers.</p>
- * @public
- */
-export interface AvailableNumberSummary {
-    /**
-     * <p>The phone number. Phone numbers are formatted <code>[+] [country code] [subscriber number including area code]</code>.</p>
-     * @public
-     */
-    PhoneNumber?: string | undefined;
-    /**
-     * <p>The ISO country code.</p>
-     * @public
-     */
-    PhoneNumberCountryCode?: PhoneNumberCountryCode | undefined;
-    /**
-     * <p>The type of phone number.</p>
-     * @public
-     */
-    PhoneNumberType?: PhoneNumberType | undefined;
-}
-/**
- * @public
- */
-export interface SearchAvailablePhoneNumbersResponse {
-    /**
-     * <p>If there are additional results, this is the token for the next set of results.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-    /**
-     * <p>A list of available phone numbers that you can claim to your Connect Customer instance or traffic distribution group.</p>
-     * @public
-     */
-    AvailableNumbersList?: AvailableNumberSummary[] | undefined;
-}
-/**
- * <p>A boolean search condition for Search APIs.</p>
- * @public
- */
-export interface BooleanCondition {
-    /**
-     * <p>A name of the property to be searched.</p>
-     * @public
-     */
-    FieldName?: string | undefined;
-    /**
-     * <p>Boolean property comparison type.</p>
-     * @public
-     */
-    ComparisonType?: BooleanComparisonType | undefined;
-}
-/**
- * <p>A datetime search condition for Search APIs.</p>
- * @public
- */
-export interface DateTimeCondition {
-    /**
-     * <p>A name of the datetime property to be searched</p>
-     * @public
-     */
-    FieldName?: string | undefined;
-    /**
-     * <p>A minimum value of the property.</p>
-     * @public
-     */
-    MinValue?: string | undefined;
-    /**
-     * <p>A maximum value of the property.</p>
-     * @public
-     */
-    MaxValue?: string | undefined;
-    /**
-     * <p>Datetime property comparison type.</p>
-     * @public
-     */
-    ComparisonType?: DateTimeComparisonType | undefined;
-}