@aws-sdk/client-connect 3.150.0 → 3.160.0

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

@@ -138,7 +138,7 @@ export interface AgentStatus {
      */
     State?: AgentStatusState | string;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -543,7 +543,7 @@ export interface AssociatePhoneNumberContactFlowRequest {
      */
     InstanceId: string | undefined;
     /**
-     * <p>The identifier of the contact flow.</p>
+     * <p>The identifier of the flow.</p>
      */
     ContactFlowId: string | undefined;
 }
@@ -642,7 +642,7 @@ export interface ClaimPhoneNumberRequest {
      */
     PhoneNumberDescription?: string;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
     /**
@@ -695,7 +695,7 @@ export interface CreateAgentStatusRequest {
      */
     DisplayOrder?: number;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -738,34 +738,34 @@ export interface CreateContactFlowRequest {
      */
     InstanceId: string | undefined;
     /**
-     * <p>The name of the contact flow.</p>
+     * <p>The name of the flow.</p>
      */
     Name: string | undefined;
     /**
-     * <p>The type of the contact flow. For descriptions of the available types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types">Choose a Contact Flow Type</a> in the <i>Amazon Connect Administrator
+     * <p>The type of the flow. For descriptions of the available types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types">Choose a flow type</a> in the <i>Amazon Connect Administrator
      *    Guide</i>.</p>
      */
     Type: ContactFlowType | string | undefined;
     /**
-     * <p>The description of the contact flow. </p>
+     * <p>The description of the flow. </p>
      */
     Description?: string;
     /**
-     * <p>The content of the contact flow. </p>
+     * <p>The content of the flow. </p>
      */
     Content: string | undefined;
     /**
-     * <p>One or more tags.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
 export interface CreateContactFlowResponse {
     /**
-     * <p>The identifier of the contact flow.</p>
+     * <p>The identifier of the flow.</p>
      */
     ContactFlowId?: string;
     /**
-     * <p>The Amazon Resource Name (ARN) of the contact flow.</p>
+     * <p>The Amazon Resource Name (ARN) of the flow.</p>
      */
     ContactFlowArn?: string;
 }
@@ -779,13 +779,13 @@ export interface ProblemDetail {
     message?: string;
 }
 /**
- * <p>The contact flow is not valid.</p>
+ * <p>The flow is not valid.</p>
  */
 export declare class InvalidContactFlowException extends __BaseException {
     readonly name: "InvalidContactFlowException";
     readonly $fault: "client";
     /**
-     * <p>The problems with the contact flow. Please fix before trying again.</p>
+     * <p>The problems with the flow. Please fix before trying again.</p>
      */
     problems?: ProblemDetail[];
     /**
@@ -799,19 +799,19 @@ export interface CreateContactFlowModuleRequest {
      */
     InstanceId: string | undefined;
     /**
-     * <p>The name of the contact flow module.</p>
+     * <p>The name of the flow module.</p>
      */
     Name: string | undefined;
     /**
-     * <p>The description of the contact flow module. </p>
+     * <p>The description of the flow module. </p>
      */
     Description?: string;
     /**
-     * <p>The content of the contact flow module.</p>
+     * <p>The content of the flow module.</p>
      */
     Content: string | undefined;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
     /**
@@ -822,11 +822,11 @@ export interface CreateContactFlowModuleRequest {
 }
 export interface CreateContactFlowModuleResponse {
     /**
-     * <p>The identifier of the contact flow module.</p>
+     * <p>The identifier of the flow module.</p>
      */
     Id?: string;
     /**
-     * <p>The Amazon Resource Name (ARN) of the contact flow module.</p>
+     * <p>The Amazon Resource Name (ARN) of the flow module.</p>
      */
     Arn?: string;
 }
@@ -903,7 +903,7 @@ export interface CreateHoursOfOperationRequest {
      */
     Config: HoursOfOperationConfig[] | undefined;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -980,6 +980,9 @@ export interface CreateIntegrationAssociationRequest {
     IntegrationType: IntegrationType | string | undefined;
     /**
      * <p>The Amazon Resource Name (ARN) of the integration.</p>
+     *          <note>
+     *             <p>When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.</p>
+     *          </note>
      */
     IntegrationArn: string | undefined;
     /**
@@ -995,7 +998,7 @@ export interface CreateIntegrationAssociationRequest {
      */
     SourceType?: SourceType | string;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -1056,7 +1059,7 @@ export interface CreateQueueRequest {
      */
     QuickConnectIds?: string[];
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -1080,7 +1083,7 @@ export interface PhoneNumberQuickConnectConfig {
     PhoneNumber: string | undefined;
 }
 /**
- * <p>Contains information about a queue for a quick connect. The contact flow must be of type
+ * <p>Contains information about a queue for a quick connect. The flow must be of type
  *    Transfer to Queue.</p>
  */
 export interface QueueQuickConnectConfig {
@@ -1089,7 +1092,7 @@ export interface QueueQuickConnectConfig {
      */
     QueueId: string | undefined;
     /**
-     * <p>The identifier of the contact flow.</p>
+     * <p>The identifier of the flow.</p>
      */
     ContactFlowId: string | undefined;
 }
@@ -1108,7 +1111,7 @@ export interface UserQuickConnectConfig {
      */
     UserId: string | undefined;
     /**
-     * <p>The identifier of the contact flow.</p>
+     * <p>The identifier of the flow.</p>
      */
     ContactFlowId: string | undefined;
 }
@@ -1152,7 +1155,7 @@ export interface CreateQuickConnectRequest {
      */
     QuickConnectConfig: QuickConnectConfig | undefined;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -1211,7 +1214,7 @@ export interface CreateRoutingProfileRequest {
      */
     MediaConcurrencies: MediaConcurrency[] | undefined;
     /**
-     * <p>One or more tags.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -1243,7 +1246,7 @@ export interface CreateSecurityProfileRequest {
      */
     InstanceId: string | undefined;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -1448,7 +1451,7 @@ export interface PropertyValidationExceptionProperty {
     Message: string | undefined;
 }
 /**
- * <p></p>
+ * <p>The property is not valid.</p>
  */
 export declare class PropertyValidationException extends __BaseException {
     readonly name: "PropertyValidationException";
@@ -1479,7 +1482,7 @@ export interface CreateUseCaseRequest {
      */
     UseCaseType: UseCaseType | string | undefined;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -1585,7 +1588,7 @@ export interface CreateUserRequest {
      */
     InstanceId: string | undefined;
     /**
-     * <p>One or more tags.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -1614,7 +1617,7 @@ export interface CreateUserHierarchyGroupRequest {
      */
     InstanceId: string | undefined;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -1658,7 +1661,7 @@ export interface CreateVocabularyRequest {
      */
     Content: string | undefined;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -1688,7 +1691,7 @@ export interface DeleteContactFlowRequest {
      */
     InstanceId: string | undefined;
     /**
-     * <p>The identifier of the contact flow.</p>
+     * <p>The identifier of the flow.</p>
      */
     ContactFlowId: string | undefined;
 }
@@ -1698,7 +1701,7 @@ export interface DeleteContactFlowModuleRequest {
      */
     InstanceId: string | undefined;
     /**
-     * <p>The identifier of the contact flow module.</p>
+     * <p>The identifier of the flow module.</p>
      */
     ContactFlowModuleId: string | undefined;
 }
@@ -1961,7 +1964,7 @@ export interface DescribeContactResponse {
     Contact?: Contact;
 }
 /**
- * <p>The contact flow has not been published.</p>
+ * <p>The flow has not been published.</p>
  */
 export declare class ContactFlowNotPublishedException extends __BaseException {
     readonly name: "ContactFlowNotPublishedException";
@@ -1978,7 +1981,7 @@ export interface DescribeContactFlowRequest {
      */
     InstanceId: string | undefined;
     /**
-     * <p>The identifier of the contact flow.</p>
+     * <p>The identifier of the flow.</p>
      */
     ContactFlowId: string | undefined;
 }
@@ -1987,46 +1990,46 @@ export declare enum ContactFlowState {
     ARCHIVED = "ARCHIVED"
 }
 /**
- * <p>Contains information about a contact flow.</p>
+ * <p>Contains information about a flow.</p>
  */
 export interface ContactFlow {
     /**
-     * <p>The Amazon Resource Name (ARN) of the contact flow.</p>
+     * <p>The Amazon Resource Name (ARN) of the flow.</p>
      */
     Arn?: string;
     /**
-     * <p>The identifier of the contact flow.</p>
+     * <p>The identifier of the flow.</p>
      */
     Id?: string;
     /**
-     * <p>The name of the contact flow.</p>
+     * <p>The name of the flow.</p>
      */
     Name?: string;
     /**
-     * <p>The type of the contact flow. For descriptions of the available types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types">Choose a Contact Flow Type</a> in the <i>Amazon Connect Administrator
+     * <p>The type of the flow. For descriptions of the available types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types">Choose a flow type</a> in the <i>Amazon Connect Administrator
      *    Guide</i>.</p>
      */
     Type?: ContactFlowType | string;
     /**
-     * <p>The type of contact flow.</p>
+     * <p>The type of flow.</p>
      */
     State?: ContactFlowState | string;
     /**
-     * <p>The description of the contact flow.</p>
+     * <p>The description of the flow.</p>
      */
     Description?: string;
     /**
-     * <p>The content of the contact flow.</p>
+     * <p>The content of the flow.</p>
      */
     Content?: string;
     /**
-     * <p>One or more tags.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
 export interface DescribeContactFlowResponse {
     /**
-     * <p>Information about the contact flow.</p>
+     * <p>Information about the flow.</p>
      */
     ContactFlow?: ContactFlow;
 }
@@ -2036,7 +2039,7 @@ export interface DescribeContactFlowModuleRequest {
      */
     InstanceId: string | undefined;
     /**
-     * <p>The identifier of the contact flow module.</p>
+     * <p>The identifier of the flow module.</p>
      */
     ContactFlowModuleId: string | undefined;
 }
@@ -2049,7 +2052,7 @@ export declare enum ContactFlowModuleStatus {
     SAVED = "SAVED"
 }
 /**
- * <p>Contains information about a contact flow module.</p>
+ * <p>Contains information about a flow module.</p>
  */
 export interface ContactFlowModule {
     /**
@@ -2057,37 +2060,37 @@ export interface ContactFlowModule {
      */
     Arn?: string;
     /**
-     * <p>The identifier of the contact flow module.</p>
+     * <p>The identifier of the flow module.</p>
      */
     Id?: string;
     /**
-     * <p>The name of the contact flow module.</p>
+     * <p>The name of the flow module.</p>
      */
     Name?: string;
     /**
-     * <p>The content of the contact flow module.</p>
+     * <p>The content of the flow module.</p>
      */
     Content?: string;
     /**
-     * <p>The description of the contact flow module.</p>
+     * <p>The description of the flow module.</p>
      */
     Description?: string;
     /**
-     * <p>The type of contact flow module.</p>
+     * <p>The type of flow module.</p>
      */
     State?: ContactFlowModuleState | string;
     /**
-     * <p>The status of the contact flow module.</p>
+     * <p>The status of the flow module.</p>
      */
     Status?: ContactFlowModuleStatus | string;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
 export interface DescribeContactFlowModuleResponse {
     /**
-     * <p>Information about the contact flow module.</p>
+     * <p>Information about the flow module.</p>
      */
     ContactFlowModule?: ContactFlowModule;
 }
@@ -2130,7 +2133,7 @@ export interface HoursOfOperation {
      */
     Config?: HoursOfOperationConfig[];
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -2575,7 +2578,7 @@ export interface ClaimedPhoneNumberSummary {
      */
     TargetArn?: string;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
     /**
@@ -2640,7 +2643,7 @@ export interface Queue {
      */
     Status?: QueueStatus | string;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -2685,7 +2688,7 @@ export interface QuickConnect {
      */
     QuickConnectConfig?: QuickConnectConfig;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -2739,7 +2742,7 @@ export interface RoutingProfile {
      */
     DefaultOutboundQueueId?: string;
     /**
-     * <p>One or more tags.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -2784,7 +2787,7 @@ export interface SecurityProfile {
      */
     Description?: string;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -2933,7 +2936,7 @@ export interface HierarchyGroup {
      */
     HierarchyPath?: HierarchyPath;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -3050,7 +3053,7 @@ export interface Vocabulary {
      */
     Content?: string;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -3998,7 +4001,7 @@ export interface GetTaskTemplateResponse {
      */
     CreatedTime?: Date;
     /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
      */
     Tags?: Record<string, string>;
 }
@@ -4118,34 +4121,34 @@ export interface ListContactFlowModulesRequest {
      */
     MaxResults?: number;
     /**
-     * <p>The state of the contact flow module.</p>
+     * <p>The state of the flow module.</p>
      */
     ContactFlowModuleState?: ContactFlowModuleState | string;
 }
 /**
- * <p>Contains summary information about a contact flow.</p>
+ * <p>Contains summary information about a flow.</p>
  */
 export interface ContactFlowModuleSummary {
     /**
-     * <p>The identifier of the contact flow module.</p>
+     * <p>The identifier of the flow module.</p>
      */
     Id?: string;
     /**
-     * <p>The Amazon Resource Name (ARN) of the contact flow module.</p>
+     * <p>The Amazon Resource Name (ARN) of the flow module.</p>
      */
     Arn?: string;
     /**
-     * <p>The name of the contact flow module.</p>
+     * <p>The name of the flow module.</p>
      */
     Name?: string;
     /**
-     * <p>The type of contact flow module.</p>
+     * <p>The type of flow module.</p>
      */
     State?: ContactFlowModuleState | string;
 }
 export interface ListContactFlowModulesResponse {
     /**
-     * <p>Information about the contact flow module.</p>
+     * <p>Information about the flow module.</p>
      */
     ContactFlowModulesSummaryList?: ContactFlowModuleSummary[];
     /**
@@ -4159,7 +4162,7 @@ export interface ListContactFlowsRequest {
      */
     InstanceId: string | undefined;
     /**
-     * <p>The type of contact flow.</p>
+     * <p>The type of flow.</p>
      */
     ContactFlowTypes?: (ContactFlowType | string)[];
     /**
@@ -4168,40 +4171,40 @@ export interface ListContactFlowsRequest {
      */
     NextToken?: string;
     /**
-     * <p>The maximum number of results to return per page.</p>
+     * <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
      */
     MaxResults?: number;
 }
 /**
- * <p>Contains summary information about a contact flow.</p>
- *          <p>You can also create and update contact flows using the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html">Amazon Connect
+ * <p>Contains summary information about a flow.</p>
+ *          <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html">Amazon Connect
  *    Flow language</a>.</p>
  */
 export interface ContactFlowSummary {
     /**
-     * <p>The identifier of the contact flow.</p>
+     * <p>The identifier of the flow.</p>
      */
     Id?: string;
     /**
-     * <p>The Amazon Resource Name (ARN) of the contact flow.</p>
+     * <p>The Amazon Resource Name (ARN) of the flow.</p>
      */
     Arn?: string;
     /**
-     * <p>The name of the contact flow.</p>
+     * <p>The name of the flow.</p>
      */
     Name?: string;
     /**
-     * <p>The type of contact flow.</p>
+     * <p>The type of flow.</p>
      */
     ContactFlowType?: ContactFlowType | string;
     /**
-     * <p>The type of contact flow.</p>
+     * <p>The type of flow.</p>
      */
     ContactFlowState?: ContactFlowState | string;
 }
 export interface ListContactFlowsResponse {
     /**
-     * <p>Information about the contact flows.</p>
+     * <p>Information about the flows.</p>
      */
     ContactFlowSummaryList?: ContactFlowSummary[];
     /**
@@ -4437,7 +4440,7 @@ export declare namespace ReferenceSummary {
 }
 export interface ListContactReferencesResponse {
     /**
-     * <p>Information about the contact flows.</p>
+     * <p>Information about the flows.</p>
      */
     ReferenceSummaryList?: ReferenceSummary[];
     /**
@@ -4513,7 +4516,7 @@ export interface ListHoursOfOperationsRequest {
      */
     NextToken?: string;
     /**
-     * <p>The maximum number of results to return per page.</p>
+     * <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
      */
     MaxResults?: number;
 }
@@ -4796,7 +4799,7 @@ export interface ListPhoneNumbersRequest {
      */
     NextToken?: string;
     /**
-     * <p>The maximum number of results to return per page.</p>
+     * <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
      */
     MaxResults?: number;
 }
@@ -4913,7 +4916,7 @@ export interface ListPromptsRequest {
      */
     NextToken?: string;
     /**
-     * <p>The maximum number of results to return per page.</p>
+     * <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
      */
     MaxResults?: number;
 }
@@ -4959,7 +4962,7 @@ export interface ListQueueQuickConnectsRequest {
      */
     NextToken?: string;
     /**
-     * <p>The maximum number of results to return per page.</p>
+     * <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
      */
     MaxResults?: number;
 }