@aws-sdk/client-connect 3.703.0 → 3.709.0

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

@@ -1208,11 +1208,13 @@ export interface AssociateFlowRequest {
      * <p>The identifier of the resource.</p>
      *          <ul>
      *             <li>
-     *                <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code>
+     *                <p>Amazon Web Services End User Messaging SMS phone number ARN when using
+     *       <code>SMS_PHONE_NUMBER</code>
      *                </p>
      *             </li>
      *             <li>
-     *                <p>Amazon Web Services End User Messaging Social phone number ARN when using <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
+     *                <p>Amazon Web Services End User Messaging Social phone number ARN when using
+     *       <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
      *                </p>
      *             </li>
      *          </ul>
@@ -2029,11 +2031,13 @@ export interface BatchGetFlowAssociationRequest {
      * <p>A list of resource identifiers to retrieve flow associations.</p>
      *          <ul>
      *             <li>
-     *                <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code>
+     *                <p>Amazon Web Services End User Messaging SMS phone number ARN when using
+     *       <code>SMS_PHONE_NUMBER</code>
      *                </p>
      *             </li>
      *             <li>
-     *                <p>Amazon Web Services End User Messaging Social phone number ARN when using <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
+     *                <p>Amazon Web Services End User Messaging Social phone number ARN when using
+     *       <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
      *                </p>
      *             </li>
      *          </ul>
@@ -3491,8 +3495,8 @@ export interface CreateIntegrationAssociationRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the integration.</p>
      *          <note>
-     *             <p>When integrating with Amazon Web Services End User Messaging, the Amazon Connect and Amazon Web Services End User Messaging
-     *     instances must be in the same account.</p>
+     *             <p>When integrating with Amazon Web Services End User Messaging, the Amazon Connect and
+     *      Amazon Web Services End User Messaging instances must be in the same account.</p>
      *          </note>
      * @public
      */
@@ -3879,6 +3883,90 @@ export interface CreatePromptResponse {
      */
     PromptId?: string | undefined;
 }
+/**
+ * <p>The contact configuration for push notification registration.</p>
+ * @public
+ */
+export interface ContactConfiguration {
+    /**
+     * <p>The identifier of the contact within the Amazon Connect instance.</p>
+     * @public
+     */
+    ContactId: string | undefined;
+    /**
+     * <p>The role of the participant in the chat conversation.</p>
+     * @public
+     */
+    ParticipantRole?: ParticipantRole | undefined;
+    /**
+     * <p>Whether to include raw connect message in the push notification payload. Default is
+     *     <code>False</code>.</p>
+     * @public
+     */
+    IncludeRawMessage?: boolean | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const DeviceType: {
+    readonly APNS: "APNS";
+    readonly APNS_SANDBOX: "APNS_SANDBOX";
+    readonly GCM: "GCM";
+};
+/**
+ * @public
+ */
+export type DeviceType = (typeof DeviceType)[keyof typeof DeviceType];
+/**
+ * @public
+ */
+export interface CreatePushNotificationRegistrationRequest {
+    /**
+     * <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>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
+     *             request. If not provided, the Amazon Web Services
+     *             SDK populates this field. For more information about idempotency, see
+     *             <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
+     * @public
+     */
+    ClientToken?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the Pinpoint application.</p>
+     * @public
+     */
+    PinpointAppArn: string | undefined;
+    /**
+     * <p>The push notification token issued by the Apple or Google gateways.</p>
+     * @public
+     */
+    DeviceToken: string | undefined;
+    /**
+     * <p>The device type to use when sending the message.</p>
+     * @public
+     */
+    DeviceType: DeviceType | undefined;
+    /**
+     * <p>The contact configuration for push notification registration.</p>
+     * @public
+     */
+    ContactConfiguration: ContactConfiguration | undefined;
+}
+/**
+ * @public
+ */
+export interface CreatePushNotificationRegistrationResponse {
+    /**
+     * <p>The identifier for the registration.</p>
+     * @public
+     */
+    RegistrationId: string | undefined;
+}
 /**
  * <p>The outbound caller ID name, number, and outbound whisper flow.</p>
  * @public
@@ -5948,6 +6036,32 @@ export interface DeletePromptRequest {
      */
     PromptId: string | undefined;
 }
+/**
+ * @public
+ */
+export interface DeletePushNotificationRegistrationRequest {
+    /**
+     * <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>The identifier for the registration.</p>
+     * @public
+     */
+    RegistrationId: string | undefined;
+    /**
+     * <p>The identifier of the contact within the Amazon Connect instance.</p>
+     * @public
+     */
+    ContactId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeletePushNotificationRegistrationResponse {
+}
 /**
  * @public
  */
@@ -6094,85 +6208,6 @@ export interface DeleteUserRequest {
      */
     UserId: string | undefined;
 }
-/**
- * @public
- */
-export interface DeleteUserHierarchyGroupRequest {
-    /**
-     * <p>The identifier of the hierarchy group.</p>
-     * @public
-     */
-    HierarchyGroupId: 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;
-}
-/**
- * @public
- */
-export interface DeleteViewRequest {
-    /**
-     * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
-     *    the instance.</p>
-     * @public
-     */
-    InstanceId: string | undefined;
-    /**
-     * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
-     *    used.</p>
-     * @public
-     */
-    ViewId: string | undefined;
-}
-/**
- * @public
- */
-export interface DeleteViewResponse {
-}
-/**
- * @public
- */
-export interface DeleteViewVersionRequest {
-    /**
-     * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
-     *    the instance.</p>
-     * @public
-     */
-    InstanceId: string | undefined;
-    /**
-     * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
-     *    used.</p>
-     * @public
-     */
-    ViewId: string | undefined;
-    /**
-     * <p>The version number of the view.</p>
-     * @public
-     */
-    ViewVersion: number | undefined;
-}
-/**
- * @public
- */
-export interface DeleteViewVersionResponse {
-}
-/**
- * @public
- */
-export interface DeleteVocabularyRequest {
-    /**
-     * <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>The identifier of the custom vocabulary.</p>
-     * @public
-     */
-    VocabularyId: string | undefined;
-}
 /**
  * @internal
  */

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

@@ -1,6 +1,85 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
 import { AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, AudioQualityMetricsInfo, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactState, CreatedByInfo, DeviceInfo, DirectoryType, Distribution, EndpointType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, ParticipantCapabilities, ParticipantRole, PredefinedAttributeValues, QueueReference, QuickConnectConfig, QuickConnectType, ReferenceStatus, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
+/**
+ * @public
+ */
+export interface DeleteUserHierarchyGroupRequest {
+    /**
+     * <p>The identifier of the hierarchy group.</p>
+     * @public
+     */
+    HierarchyGroupId: 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;
+}
+/**
+ * @public
+ */
+export interface DeleteViewRequest {
+    /**
+     * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
+     *    the instance.</p>
+     * @public
+     */
+    InstanceId: string | undefined;
+    /**
+     * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
+     *    used.</p>
+     * @public
+     */
+    ViewId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteViewResponse {
+}
+/**
+ * @public
+ */
+export interface DeleteViewVersionRequest {
+    /**
+     * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
+     *    the instance.</p>
+     * @public
+     */
+    InstanceId: string | undefined;
+    /**
+     * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
+     *    used.</p>
+     * @public
+     */
+    ViewId: string | undefined;
+    /**
+     * <p>The version number of the view.</p>
+     * @public
+     */
+    ViewVersion: number | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteViewVersionResponse {
+}
+/**
+ * @public
+ */
+export interface DeleteVocabularyRequest {
+    /**
+     * <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>The identifier of the custom vocabulary.</p>
+     * @public
+     */
+    VocabularyId: string | undefined;
+}
 /**
  * @public
  */
@@ -1704,8 +1783,9 @@ export interface ClaimedPhoneNumberSummary {
     PhoneNumberStatus?: PhoneNumberStatus | undefined;
     /**
      * <p>The claimed phone number ARN that was previously imported from the external service, such as
-     *    Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number
-     *    that was imported from Amazon Web Services End User Messaging.</p>
+     *     Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it
+     *    looks like the ARN of the phone number that was imported from Amazon Web Services End User
+     *    Messaging.</p>
      * @public
      */
     SourcePhoneNumberArn?: string | undefined;
@@ -2912,11 +2992,13 @@ export interface DisassociateFlowRequest {
      * <p>The identifier of the resource.</p>
      *          <ul>
      *             <li>
-     *                <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code>
+     *                <p>Amazon Web Services End User Messaging SMS phone number ARN when using
+     *       <code>SMS_PHONE_NUMBER</code>
      *                </p>
      *             </li>
      *             <li>
-     *                <p>Amazon Web Services End User Messaging Social phone number ARN when using <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
+     *                <p>Amazon Web Services End User Messaging Social phone number ARN when using
+     *       <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
      *                </p>
      *             </li>
      *          </ul>
@@ -4024,11 +4106,13 @@ export interface GetFlowAssociationRequest {
      * <p>The identifier of the resource.</p>
      *          <ul>
      *             <li>
-     *                <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code>
+     *                <p>Amazon Web Services End User Messaging SMS phone number ARN when using
+     *       <code>SMS_PHONE_NUMBER</code>
      *                </p>
      *             </li>
      *             <li>
-     *                <p>Amazon Web Services End User Messaging Social phone number ARN when using <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
+     *                <p>Amazon Web Services End User Messaging Social phone number ARN when using
+     *       <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
      *                </p>
      *             </li>
      *          </ul>
@@ -4558,18 +4642,14 @@ export interface MetricFilterV2 {
      *          <p>For valid values of the metric-level filter <code>FLOWS_OUTCOME_TYPE</code>, see the
      *    description for the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical">Flow outcome</a> metric in the <i>Amazon Connect Administrator
      *    Guide</i>.</p>
-     *          <p>For valid values of the metric-level filter <code>BOT_CONVERSATION_OUTCOME_TYPE</code>, see the
-     *    description for the
-     *    <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric">Bot conversations completed</a>
-     *
-     *    in the <i>Amazon Connect Administrator
-     *     Guide</i>.</p>
-     *          <p>For valid values of the metric-level filter <code>BOT_INTENT_OUTCOME_TYPE</code>, see the description for
-     *    the
-     *    <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric">Bot intents completed</a>
-     *
-     *     metric in the <i>Amazon Connect Administrator
+     *          <p>For valid values of the metric-level filter <code>BOT_CONVERSATION_OUTCOME_TYPE</code>, see
+     *    the description for the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric">Bot
+     *     conversations completed</a> in the <i>Amazon Connect Administrator
      *     Guide</i>.</p>
+     *          <p>For valid values of the metric-level filter <code>BOT_INTENT_OUTCOME_TYPE</code>, see the
+     *    description for the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric">Bot intents
+     *     completed</a> metric in the <i>Amazon Connect Administrator
+     *    Guide</i>.</p>
      * @public
      */
     MetricFilterValues?: string[] | undefined;
@@ -6102,8 +6182,8 @@ export interface ImportPhoneNumberRequest {
      */
     InstanceId: string | undefined;
     /**
-     * <p>The claimed phone number ARN being imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number to
-     *    import from Amazon Web Services End User Messaging.</p>
+     * <p>The claimed phone number ARN being imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks
+     *    like the ARN of the phone number to import from Amazon Web Services End User Messaging.</p>
      * @public
      */
     SourcePhoneNumberArn: string | undefined;
@@ -7999,8 +8079,9 @@ export interface ListPhoneNumbersSummary {
     PhoneNumberDescription?: string | undefined;
     /**
      * <p>The claimed phone number ARN that was previously imported from the external service, such as
-     *    Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number
-     *    that was imported from Amazon Web Services End User Messaging.</p>
+     *     Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it
+     *    looks like the ARN of the phone number that was imported from Amazon Web Services End User
+     *    Messaging.</p>
      * @public
      */
     SourcePhoneNumberArn?: string | undefined;
@@ -8706,159 +8787,6 @@ export interface RealTimeContactAnalysisSegmentIssues {
      */
     IssuesDetected: RealTimeContactAnalysisIssueDetected[] | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const RealTimeContactAnalysisPostContactSummaryFailureCode: {
-    readonly FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES";
-    readonly INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT";
-    readonly INTERNAL_ERROR: "INTERNAL_ERROR";
-    readonly INVALID_ANALYSIS_CONFIGURATION: "INVALID_ANALYSIS_CONFIGURATION";
-    readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
-};
-/**
- * @public
- */
-export type RealTimeContactAnalysisPostContactSummaryFailureCode = (typeof RealTimeContactAnalysisPostContactSummaryFailureCode)[keyof typeof RealTimeContactAnalysisPostContactSummaryFailureCode];
-/**
- * @public
- * @enum
- */
-export declare const RealTimeContactAnalysisPostContactSummaryStatus: {
-    readonly COMPLETED: "COMPLETED";
-    readonly FAILED: "FAILED";
-};
-/**
- * @public
- */
-export type RealTimeContactAnalysisPostContactSummaryStatus = (typeof RealTimeContactAnalysisPostContactSummaryStatus)[keyof typeof RealTimeContactAnalysisPostContactSummaryStatus];
-/**
- * <p>Information about the post-contact summary for a real-time contact segment.</p>
- * @public
- */
-export interface RealTimeContactAnalysisSegmentPostContactSummary {
-    /**
-     * <p>The content of the summary.</p>
-     * @public
-     */
-    Content?: string | undefined;
-    /**
-     * <p>Whether the summary was successfully COMPLETED or FAILED to be generated.</p>
-     * @public
-     */
-    Status: RealTimeContactAnalysisPostContactSummaryStatus | undefined;
-    /**
-     * <p>If the summary failed to be generated, one of the following failure codes occurs:</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached your service
-     *      quota.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: The conversation needs to have at least
-     *      one turn from both the participants in order to generate the summary.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>FAILED_SAFETY_GUIDELINES</code>: The generated summary cannot be provided because it
-     *      failed to meet system safety guidelines.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>INVALID_ANALYSIS_CONFIGURATION</code>: This code occurs when, for example, you're
-     *      using a <a href="https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#supported-languages-contact-lens">language</a> that isn't supported by generative AI-powered post-contact summaries.
-     *     </p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>INTERNAL_ERROR</code>: Internal system error.</p>
-     *             </li>
-     *          </ul>
-     * @public
-     */
-    FailureCode?: RealTimeContactAnalysisPostContactSummaryFailureCode | undefined;
-}
-/**
- * <p>Object describing redaction applied to the segment.</p>
- * @public
- */
-export interface RealTimeContactAnalysisTranscriptItemRedaction {
-    /**
-     * <p>List of character intervals each describing a part of the text that was redacted. For
-     *     <code>OutputType.Raw</code>, part of the original text that contains data that can be redacted.
-     *    For <code> OutputType.Redacted</code>, part of the string with redaction tag.</p>
-     * @public
-     */
-    CharacterOffsets?: RealTimeContactAnalysisCharacterInterval[] | undefined;
-}
-/**
- * @public
- * @enum
- */
-export declare const RealTimeContactAnalysisSentimentLabel: {
-    readonly NEGATIVE: "NEGATIVE";
-    readonly NEUTRAL: "NEUTRAL";
-    readonly POSITIVE: "POSITIVE";
-};
-/**
- * @public
- */
-export type RealTimeContactAnalysisSentimentLabel = (typeof RealTimeContactAnalysisSentimentLabel)[keyof typeof RealTimeContactAnalysisSentimentLabel];
-/**
- * <p>The analyzed transcript segment.</p>
- * @public
- */
-export interface RealTimeContactAnalysisSegmentTranscript {
-    /**
-     * <p>The identifier of the transcript.</p>
-     * @public
-     */
-    Id: string | undefined;
-    /**
-     * <p>The identifier of the participant.</p>
-     * @public
-     */
-    ParticipantId: string | undefined;
-    /**
-     * <p>The role of the participant. For example, is it a customer, agent, or system.</p>
-     * @public
-     */
-    ParticipantRole: ParticipantRole | undefined;
-    /**
-     * <p>The display name of the participant.</p>
-     * @public
-     */
-    DisplayName?: string | undefined;
-    /**
-     * <p>The content of the transcript. Can be redacted.</p>
-     * @public
-     */
-    Content: string | undefined;
-    /**
-     * <p>The type of content of the item. For example, <code>text/plain</code>.</p>
-     * @public
-     */
-    ContentType?: string | undefined;
-    /**
-     * <p>Field describing the time of the event. It can have different representations of time.</p>
-     * @public
-     */
-    Time: RealTimeContactAnalysisTimeData | undefined;
-    /**
-     * <p>Object describing redaction that was applied to the transcript. If transcript has the field
-     *    it means part of the transcript was redacted.</p>
-     * @public
-     */
-    Redaction?: RealTimeContactAnalysisTranscriptItemRedaction | undefined;
-    /**
-     * <p>The sentiment detected for this piece of transcript.</p>
-     * @public
-     */
-    Sentiment?: RealTimeContactAnalysisSentimentLabel | undefined;
-}
 /**
  * @internal
  */