@aws-sdk/client-connect 3.438.0 → 3.441.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/README.md +11 -3
  2. package/dist-cjs/Connect.js +2 -0
  3. package/dist-cjs/commands/BatchGetFlowAssociationCommand.js +51 -0
  4. package/dist-cjs/commands/DescribeViewCommand.js +2 -2
  5. package/dist-cjs/commands/index.js +1 -0
  6. package/dist-cjs/models/models_0.js +6 -7
  7. package/dist-cjs/models/models_1.js +7 -14
  8. package/dist-cjs/models/models_2.js +14 -1
  9. package/dist-cjs/protocols/Aws_restJson1.js +468 -34
  10. package/dist-es/Connect.js +2 -0
  11. package/dist-es/commands/BatchGetFlowAssociationCommand.js +47 -0
  12. package/dist-es/commands/DescribeViewCommand.js +1 -1
  13. package/dist-es/commands/index.js +1 -0
  14. package/dist-es/models/models_0.js +4 -4
  15. package/dist-es/models/models_1.js +5 -13
  16. package/dist-es/models/models_2.js +13 -0
  17. package/dist-es/protocols/Aws_restJson1.js +457 -25
  18. package/dist-types/Connect.d.ts +10 -3
  19. package/dist-types/ConnectClient.d.ts +6 -5
  20. package/dist-types/commands/BatchGetFlowAssociationCommand.d.ts +101 -0
  21. package/dist-types/commands/ClaimPhoneNumberCommand.d.ts +2 -1
  22. package/dist-types/commands/CreateViewCommand.d.ts +5 -7
  23. package/dist-types/commands/CreateViewVersionCommand.d.ts +3 -3
  24. package/dist-types/commands/DeleteViewCommand.d.ts +1 -2
  25. package/dist-types/commands/DescribeAgentStatusCommand.d.ts +2 -0
  26. package/dist-types/commands/DescribeHoursOfOperationCommand.d.ts +2 -0
  27. package/dist-types/commands/DescribePhoneNumberCommand.d.ts +1 -0
  28. package/dist-types/commands/DescribePromptCommand.d.ts +2 -0
  29. package/dist-types/commands/DescribeQueueCommand.d.ts +2 -0
  30. package/dist-types/commands/DescribeQuickConnectCommand.d.ts +2 -0
  31. package/dist-types/commands/DescribeRoutingProfileCommand.d.ts +3 -0
  32. package/dist-types/commands/DescribeSecurityProfileCommand.d.ts +2 -0
  33. package/dist-types/commands/DescribeUserCommand.d.ts +2 -0
  34. package/dist-types/commands/DescribeUserHierarchyGroupCommand.d.ts +12 -0
  35. package/dist-types/commands/DescribeUserHierarchyStructureCommand.d.ts +12 -1
  36. package/dist-types/commands/DescribeViewCommand.d.ts +5 -5
  37. package/dist-types/commands/GetPromptFileCommand.d.ts +2 -0
  38. package/dist-types/commands/ListAgentStatusesCommand.d.ts +2 -0
  39. package/dist-types/commands/ListHoursOfOperationsCommand.d.ts +2 -0
  40. package/dist-types/commands/ListPhoneNumbersV2Command.d.ts +2 -0
  41. package/dist-types/commands/ListPromptsCommand.d.ts +2 -0
  42. package/dist-types/commands/ListQueueQuickConnectsCommand.d.ts +4 -0
  43. package/dist-types/commands/ListQueuesCommand.d.ts +2 -0
  44. package/dist-types/commands/ListQuickConnectsCommand.d.ts +2 -0
  45. package/dist-types/commands/ListRoutingProfileQueuesCommand.d.ts +2 -0
  46. package/dist-types/commands/ListRoutingProfilesCommand.d.ts +2 -0
  47. package/dist-types/commands/ListSecurityProfileApplicationsCommand.d.ts +3 -1
  48. package/dist-types/commands/ListSecurityProfilePermissionsCommand.d.ts +2 -0
  49. package/dist-types/commands/ListSecurityProfilesCommand.d.ts +2 -0
  50. package/dist-types/commands/ListUserHierarchyGroupsCommand.d.ts +2 -0
  51. package/dist-types/commands/ListUsersCommand.d.ts +2 -0
  52. package/dist-types/commands/ListViewVersionsCommand.d.ts +1 -2
  53. package/dist-types/commands/ReplicateInstanceCommand.d.ts +3 -1
  54. package/dist-types/commands/ResumeContactRecordingCommand.d.ts +3 -1
  55. package/dist-types/commands/SearchAvailablePhoneNumbersCommand.d.ts +2 -1
  56. package/dist-types/commands/SearchHoursOfOperationsCommand.d.ts +2 -0
  57. package/dist-types/commands/SearchPromptsCommand.d.ts +2 -0
  58. package/dist-types/commands/SearchQueuesCommand.d.ts +2 -0
  59. package/dist-types/commands/SearchQuickConnectsCommand.d.ts +2 -0
  60. package/dist-types/commands/SearchRoutingProfilesCommand.d.ts +3 -0
  61. package/dist-types/commands/SuspendContactRecordingCommand.d.ts +5 -3
  62. package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +2 -1
  63. package/dist-types/commands/UpdateViewContentCommand.d.ts +4 -6
  64. package/dist-types/commands/index.d.ts +1 -0
  65. package/dist-types/index.d.ts +3 -3
  66. package/dist-types/models/models_0.d.ts +231 -107
  67. package/dist-types/models/models_1.d.ts +242 -129
  68. package/dist-types/models/models_2.d.ts +116 -14
  69. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  70. package/dist-types/ts3.4/Connect.d.ts +17 -0
  71. package/dist-types/ts3.4/ConnectClient.d.ts +6 -0
  72. package/dist-types/ts3.4/commands/BatchGetFlowAssociationCommand.d.ts +42 -0
  73. package/dist-types/ts3.4/commands/DescribeUserHierarchyStructureCommand.d.ts +2 -4
  74. package/dist-types/ts3.4/commands/DescribeViewCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  76. package/dist-types/ts3.4/models/models_0.d.ts +47 -21
  77. package/dist-types/ts3.4/models/models_1.d.ts +50 -41
  78. package/dist-types/ts3.4/models/models_2.d.ts +44 -2
  79. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  80. package/package.json +4 -4
@@ -46,6 +46,8 @@ export interface ListRoutingProfilesCommandOutput extends ListRoutingProfilesRes
46
46
  * // Id: "STRING_VALUE",
47
47
  * // Arn: "STRING_VALUE",
48
48
  * // Name: "STRING_VALUE",
49
+ * // LastModifiedTime: new Date("TIMESTAMP"),
50
+ * // LastModifiedRegion: "STRING_VALUE",
49
51
  * // },
50
52
  * // ],
51
53
  * // NextToken: "STRING_VALUE",
@@ -23,7 +23,7 @@ export interface ListSecurityProfileApplicationsCommandOutput extends ListSecuri
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Returns a list of third party applications in a specific security profile.</p>
26
+ * <p>Returns a list of third-party applications in a specific security profile.</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
@@ -48,6 +48,8 @@ export interface ListSecurityProfileApplicationsCommandOutput extends ListSecuri
48
48
  * // },
49
49
  * // ],
50
50
  * // NextToken: "STRING_VALUE",
51
+ * // LastModifiedTime: new Date("TIMESTAMP"),
52
+ * // LastModifiedRegion: "STRING_VALUE",
51
53
  * // };
52
54
  *
53
55
  * ```
@@ -43,6 +43,8 @@ export interface ListSecurityProfilePermissionsCommandOutput extends ListSecurit
43
43
  * // "STRING_VALUE",
44
44
  * // ],
45
45
  * // NextToken: "STRING_VALUE",
46
+ * // LastModifiedTime: new Date("TIMESTAMP"),
47
+ * // LastModifiedRegion: "STRING_VALUE",
46
48
  * // };
47
49
  *
48
50
  * ```
@@ -45,6 +45,8 @@ export interface ListSecurityProfilesCommandOutput extends ListSecurityProfilesR
45
45
  * // Id: "STRING_VALUE",
46
46
  * // Arn: "STRING_VALUE",
47
47
  * // Name: "STRING_VALUE",
48
+ * // LastModifiedTime: new Date("TIMESTAMP"),
49
+ * // LastModifiedRegion: "STRING_VALUE",
48
50
  * // },
49
51
  * // ],
50
52
  * // NextToken: "STRING_VALUE",
@@ -46,6 +46,8 @@ export interface ListUserHierarchyGroupsCommandOutput extends ListUserHierarchyG
46
46
  * // Id: "STRING_VALUE",
47
47
  * // Arn: "STRING_VALUE",
48
48
  * // Name: "STRING_VALUE",
49
+ * // LastModifiedTime: new Date("TIMESTAMP"),
50
+ * // LastModifiedRegion: "STRING_VALUE",
49
51
  * // },
50
52
  * // ],
51
53
  * // NextToken: "STRING_VALUE",
@@ -44,6 +44,8 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
44
44
  * // Id: "STRING_VALUE",
45
45
  * // Arn: "STRING_VALUE",
46
46
  * // Username: "STRING_VALUE",
47
+ * // LastModifiedTime: new Date("TIMESTAMP"),
48
+ * // LastModifiedRegion: "STRING_VALUE",
47
49
  * // },
48
50
  * // ],
49
51
  * // NextToken: "STRING_VALUE",
@@ -23,8 +23,7 @@ export interface ListViewVersionsCommandOutput extends ListViewVersionsResponse,
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Returns all the available versions for the specified Amazon Connect instance and view
27
- * identifier.</p>
26
+ * <p>Returns all the available versions for the specified Amazon Connect instance and view identifier.</p>
28
27
  * <p>Results will be sorted from highest to lowest.</p>
29
28
  * @example
30
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,7 +23,9 @@ export interface ReplicateInstanceCommandOutput extends ReplicateInstanceRespons
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Replicates an Amazon Connect instance in the specified Amazon Web Services Region.</p>
26
+ * <p>Replicates an Amazon Connect instance in the specified Amazon Web Services Region
27
+ * and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
28
+ * </p>
27
29
  * <p>For more information about replicating an Amazon Connect instance, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html">Create
28
30
  * a replica of your existing Amazon Connect instance</a> in the <i>Amazon Connect
29
31
  * Administrator Guide</i>.</p>
@@ -24,7 +24,9 @@ export interface ResumeContactRecordingCommandOutput extends ResumeContactRecord
24
24
  /**
25
25
  * @public
26
26
  * <p>When a contact is being recorded, and the recording has been suspended using
27
- * SuspendContactRecording, this API resumes recording the call or screen.</p>
27
+ * SuspendContactRecording, this API resumes recording whatever recording is selected in the flow
28
+ * configuration: call, screen, or both. If only call recording or only screen recording is enabled,
29
+ * then it would resume.</p>
28
30
  * <p>Voice and screen recordings are supported.</p>
29
31
  * @example
30
32
  * Use a bare-bones client and the command you need to make an API call.
@@ -33,7 +33,8 @@ export interface SearchAvailablePhoneNumbersCommandOutput extends SearchAvailabl
33
33
  * // const { ConnectClient, SearchAvailablePhoneNumbersCommand } = require("@aws-sdk/client-connect"); // CommonJS import
34
34
  * const client = new ConnectClient(config);
35
35
  * const input = { // SearchAvailablePhoneNumbersRequest
36
- * TargetArn: "STRING_VALUE", // required
36
+ * TargetArn: "STRING_VALUE",
37
+ * InstanceId: "STRING_VALUE",
37
38
  * PhoneNumberCountryCode: "AF" || "AL" || "DZ" || "AS" || "AD" || "AO" || "AI" || "AQ" || "AG" || "AR" || "AM" || "AW" || "AU" || "AT" || "AZ" || "BS" || "BH" || "BD" || "BB" || "BY" || "BE" || "BZ" || "BJ" || "BM" || "BT" || "BO" || "BA" || "BW" || "BR" || "IO" || "VG" || "BN" || "BG" || "BF" || "BI" || "KH" || "CM" || "CA" || "CV" || "KY" || "CF" || "TD" || "CL" || "CN" || "CX" || "CC" || "CO" || "KM" || "CK" || "CR" || "HR" || "CU" || "CW" || "CY" || "CZ" || "CD" || "DK" || "DJ" || "DM" || "DO" || "TL" || "EC" || "EG" || "SV" || "GQ" || "ER" || "EE" || "ET" || "FK" || "FO" || "FJ" || "FI" || "FR" || "PF" || "GA" || "GM" || "GE" || "DE" || "GH" || "GI" || "GR" || "GL" || "GD" || "GU" || "GT" || "GG" || "GN" || "GW" || "GY" || "HT" || "HN" || "HK" || "HU" || "IS" || "IN" || "ID" || "IR" || "IQ" || "IE" || "IM" || "IL" || "IT" || "CI" || "JM" || "JP" || "JE" || "JO" || "KZ" || "KE" || "KI" || "KW" || "KG" || "LA" || "LV" || "LB" || "LS" || "LR" || "LY" || "LI" || "LT" || "LU" || "MO" || "MK" || "MG" || "MW" || "MY" || "MV" || "ML" || "MT" || "MH" || "MR" || "MU" || "YT" || "MX" || "FM" || "MD" || "MC" || "MN" || "ME" || "MS" || "MA" || "MZ" || "MM" || "NA" || "NR" || "NP" || "NL" || "AN" || "NC" || "NZ" || "NI" || "NE" || "NG" || "NU" || "KP" || "MP" || "NO" || "OM" || "PK" || "PW" || "PA" || "PG" || "PY" || "PE" || "PH" || "PN" || "PL" || "PT" || "PR" || "QA" || "CG" || "RE" || "RO" || "RU" || "RW" || "BL" || "SH" || "KN" || "LC" || "MF" || "PM" || "VC" || "WS" || "SM" || "ST" || "SA" || "SN" || "RS" || "SC" || "SL" || "SG" || "SX" || "SK" || "SI" || "SB" || "SO" || "ZA" || "KR" || "ES" || "LK" || "SD" || "SR" || "SJ" || "SZ" || "SE" || "CH" || "SY" || "TW" || "TJ" || "TZ" || "TH" || "TG" || "TK" || "TO" || "TT" || "TN" || "TR" || "TM" || "TC" || "TV" || "VI" || "UG" || "UA" || "AE" || "GB" || "US" || "UY" || "UZ" || "VU" || "VA" || "VE" || "VN" || "WF" || "EH" || "YE" || "ZM" || "ZW", // required
38
39
  * PhoneNumberType: "TOLL_FREE" || "DID" || "UIFN" || "SHARED" || "THIRD_PARTY_TF" || "THIRD_PARTY_DID", // required
39
40
  * PhoneNumberPrefix: "STRING_VALUE",
@@ -107,6 +107,8 @@ export interface SearchHoursOfOperationsCommandOutput extends SearchHoursOfOpera
107
107
  * // Tags: { // TagMap
108
108
  * // "<keys>": "STRING_VALUE",
109
109
  * // },
110
+ * // LastModifiedTime: new Date("TIMESTAMP"),
111
+ * // LastModifiedRegion: "STRING_VALUE",
110
112
  * // },
111
113
  * // ],
112
114
  * // NextToken: "STRING_VALUE",
@@ -92,6 +92,8 @@ export interface SearchPromptsCommandOutput extends SearchPromptsResponse, __Met
92
92
  * // Tags: { // TagMap
93
93
  * // "<keys>": "STRING_VALUE",
94
94
  * // },
95
+ * // LastModifiedTime: new Date("TIMESTAMP"),
96
+ * // LastModifiedRegion: "STRING_VALUE",
95
97
  * // },
96
98
  * // ],
97
99
  * // NextToken: "STRING_VALUE",
@@ -102,6 +102,8 @@ export interface SearchQueuesCommandOutput extends SearchQueuesResponse, __Metad
102
102
  * // Tags: { // TagMap
103
103
  * // "<keys>": "STRING_VALUE",
104
104
  * // },
105
+ * // LastModifiedTime: new Date("TIMESTAMP"),
106
+ * // LastModifiedRegion: "STRING_VALUE",
105
107
  * // },
106
108
  * // ],
107
109
  * // NextToken: "STRING_VALUE",
@@ -106,6 +106,8 @@ export interface SearchQuickConnectsCommandOutput extends SearchQuickConnectsRes
106
106
  * // Tags: { // TagMap
107
107
  * // "<keys>": "STRING_VALUE",
108
108
  * // },
109
+ * // LastModifiedTime: new Date("TIMESTAMP"),
110
+ * // LastModifiedRegion: "STRING_VALUE",
109
111
  * // },
110
112
  * // ],
111
113
  * // NextToken: "STRING_VALUE",
@@ -106,6 +106,9 @@ export interface SearchRoutingProfilesCommandOutput extends SearchRoutingProfile
106
106
  * // NumberOfAssociatedQueues: Number("long"),
107
107
  * // NumberOfAssociatedUsers: Number("long"),
108
108
  * // AgentAvailabilityTimer: "TIME_SINCE_LAST_ACTIVITY" || "TIME_SINCE_LAST_INBOUND",
109
+ * // LastModifiedTime: new Date("TIMESTAMP"),
110
+ * // LastModifiedRegion: "STRING_VALUE",
111
+ * // IsDefault: true || false,
109
112
  * // },
110
113
  * // ],
111
114
  * // NextToken: "STRING_VALUE",
@@ -23,9 +23,11 @@ export interface SuspendContactRecordingCommandOutput extends SuspendContactReco
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>When a contact is being recorded, this API suspends recording the call or screen. For
27
- * example, you might suspend the call or screen recording while collecting sensitive information,
28
- * such as a credit card number. Then use ResumeContactRecording to restart recording.</p>
26
+ * <p>When a contact is being recorded, this API suspends recording whatever is selected in the
27
+ * flow configuration: call, screen, or both. If only call recording or only screen recording is
28
+ * enabled, then it would be suspended. For example, you might suspend the screen
29
+ * recording while collecting sensitive information, such as a credit card number. Then use
30
+ * ResumeContactRecording to restart recording the screen.</p>
29
31
  * <p>The period of time that the recording is suspended is filled with silence in the final
30
32
  * recording.</p>
31
33
  * <p>Voice and screen recordings are supported.</p>
@@ -42,7 +42,8 @@ export interface UpdatePhoneNumberCommandOutput extends UpdatePhoneNumberRespons
42
42
  * const client = new ConnectClient(config);
43
43
  * const input = { // UpdatePhoneNumberRequest
44
44
  * PhoneNumberId: "STRING_VALUE", // required
45
- * TargetArn: "STRING_VALUE", // required
45
+ * TargetArn: "STRING_VALUE",
46
+ * InstanceId: "STRING_VALUE",
46
47
  * ClientToken: "STRING_VALUE",
47
48
  * };
48
49
  * const command = new UpdatePhoneNumberCommand(input);
@@ -23,12 +23,10 @@ export interface UpdateViewContentCommandOutput extends UpdateViewContentRespons
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Updates the view content of the given view identifier in the specified Amazon Connect
27
- * instance.</p>
28
- * <p>It performs content validation if <code>Status</code> is set to <code>SAVED</code> and
29
- * performs full content validation if <code>Status</code> is <code>PUBLISHED</code>. Note that the
30
- * <code>$SAVED</code> alias' content will always be updated, but the <code>$LATEST</code> alias'
31
- * content will only be updated if <code>Status</code> is <code>PUBLISHED</code>.</p>
26
+ * <p>Updates the view content of the given view identifier in the specified Amazon Connect instance.</p>
27
+ * <p>It performs content validation if <code>Status</code> is set to <code>SAVED</code> and performs full content validation if
28
+ * <code>Status</code> is <code>PUBLISHED</code>. Note that the <code>$SAVED</code> alias' content will always be updated,
29
+ * but the <code>$LATEST</code> alias' content will only be updated if <code>Status</code> is <code>PUBLISHED</code>.</p>
32
30
  * @example
33
31
  * Use a bare-bones client and the command you need to make an API call.
34
32
  * ```javascript
@@ -10,6 +10,7 @@ export * from "./AssociateQueueQuickConnectsCommand";
10
10
  export * from "./AssociateRoutingProfileQueuesCommand";
11
11
  export * from "./AssociateSecurityKeyCommand";
12
12
  export * from "./AssociateTrafficDistributionGroupUserCommand";
13
+ export * from "./BatchGetFlowAssociationCommand";
13
14
  export * from "./ClaimPhoneNumberCommand";
14
15
  export * from "./CreateAgentStatusCommand";
15
16
  export * from "./CreateContactFlowCommand";
@@ -5,9 +5,9 @@
5
5
  * contact routing. You can also resolve customer issues more efficiently by getting customers in
6
6
  * touch with the appropriate agents.</p>
7
7
  * <p>There are limits to the number of Amazon Connect resources that you can create. There
8
- * are also limits to the number of requests that you can make per second. For more information,
9
- * seeP98941055 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service
10
- * Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
8
+ * are also limits to the number of requests that you can make per second. For more information, see
9
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
10
+ * Guide</i>.</p>
11
11
  * <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
12
12
  * a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
13
13
  *