@aws-sdk/client-connect 3.1048.0 → 3.1050.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.
- package/README.md +8 -8
- package/dist-types/Connect.d.ts +8 -8
- package/dist-types/ConnectClient.d.ts +8 -8
- package/dist-types/commands/ActivateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/AssociateAnalyticsDataSetCommand.d.ts +1 -1
- package/dist-types/commands/AssociateApprovedOriginCommand.d.ts +2 -2
- package/dist-types/commands/AssociateBotCommand.d.ts +2 -2
- package/dist-types/commands/AssociateContactWithUserCommand.d.ts +3 -3
- package/dist-types/commands/AssociateDefaultVocabularyCommand.d.ts +1 -1
- package/dist-types/commands/AssociateEmailAddressAliasCommand.d.ts +4 -4
- package/dist-types/commands/AssociateInstanceStorageConfigCommand.d.ts +1 -1
- package/dist-types/commands/AssociateLambdaFunctionCommand.d.ts +2 -2
- package/dist-types/commands/AssociateLexBotCommand.d.ts +2 -2
- package/dist-types/commands/AssociatePhoneNumberContactFlowCommand.d.ts +1 -1
- package/dist-types/commands/AssociateQueueEmailAddressesCommand.d.ts +1 -1
- package/dist-types/commands/AssociateSecurityKeyCommand.d.ts +1 -1
- package/dist-types/commands/BatchAssociateAnalyticsDataSetCommand.d.ts +1 -1
- package/dist-types/commands/BatchDisassociateAnalyticsDataSetCommand.d.ts +1 -1
- package/dist-types/commands/BatchPutContactCommand.d.ts +2 -2
- package/dist-types/commands/ClaimPhoneNumberCommand.d.ts +3 -3
- package/dist-types/commands/CreateAgentStatusCommand.d.ts +1 -1
- package/dist-types/commands/CreateContactFlowCommand.d.ts +2 -2
- package/dist-types/commands/CreateContactFlowModuleCommand.d.ts +1 -1
- package/dist-types/commands/CreateEmailAddressCommand.d.ts +2 -2
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/CreateHoursOfOperationOverrideCommand.d.ts +1 -1
- package/dist-types/commands/CreateInstanceCommand.d.ts +6 -6
- package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/commands/CreatePersistentContactAssociationCommand.d.ts +1 -1
- package/dist-types/commands/CreatePredefinedAttributeCommand.d.ts +3 -3
- package/dist-types/commands/CreatePromptCommand.d.ts +1 -1
- package/dist-types/commands/CreatePushNotificationRegistrationCommand.d.ts +1 -1
- package/dist-types/commands/CreateQueueCommand.d.ts +2 -2
- package/dist-types/commands/CreateQuickConnectCommand.d.ts +1 -1
- package/dist-types/commands/CreateRuleCommand.d.ts +1 -1
- package/dist-types/commands/CreateSecurityProfileCommand.d.ts +1 -1
- package/dist-types/commands/CreateTaskTemplateCommand.d.ts +1 -1
- package/dist-types/commands/CreateTrafficDistributionGroupCommand.d.ts +2 -2
- package/dist-types/commands/CreateUserCommand.d.ts +3 -3
- package/dist-types/commands/CreateVocabularyCommand.d.ts +2 -2
- package/dist-types/commands/DeactivateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/DeleteContactEvaluationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteContactFlowCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEmailAddressCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/DeleteHoursOfOperationOverrideCommand.d.ts +1 -1
- package/dist-types/commands/DeleteInstanceCommand.d.ts +4 -4
- package/dist-types/commands/DeleteIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/commands/DeletePredefinedAttributeCommand.d.ts +1 -1
- package/dist-types/commands/DeleteQuickConnectCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRuleCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTrafficDistributionGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +5 -5
- package/dist-types/commands/DescribeAttachedFilesConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAuthenticationProfileCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContactCommand.d.ts +4 -4
- package/dist-types/commands/DescribeContactEvaluationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContactFlowCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEmailAddressCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstanceAttributeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstanceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstanceStorageConfigCommand.d.ts +1 -1
- package/dist-types/commands/DescribePhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/DescribePredefinedAttributeCommand.d.ts +3 -3
- package/dist-types/commands/DescribeRuleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSecurityProfileCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserHierarchyStructureCommand.d.ts +1 -1
- package/dist-types/commands/DescribeViewCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateAnalyticsDataSetCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateApprovedOriginCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateBotCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateEmailAddressAliasCommand.d.ts +3 -3
- package/dist-types/commands/DisassociateInstanceStorageConfigCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateLambdaFunctionCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateLexBotCommand.d.ts +1 -1
- package/dist-types/commands/DisassociatePhoneNumberContactFlowCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateSecurityKeyCommand.d.ts +1 -1
- package/dist-types/commands/GetContactMetricsCommand.d.ts +2 -2
- package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +2 -2
- package/dist-types/commands/GetCurrentUserDataCommand.d.ts +1 -1
- package/dist-types/commands/GetFederationTokenCommand.d.ts +5 -5
- package/dist-types/commands/GetMetricDataCommand.d.ts +2 -2
- package/dist-types/commands/GetMetricDataV2Command.d.ts +2 -2
- package/dist-types/commands/GetTaskTemplateCommand.d.ts +1 -1
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/ListAnalyticsDataAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/ListAnalyticsDataLakeDataSetsCommand.d.ts +1 -1
- package/dist-types/commands/ListApprovedOriginsCommand.d.ts +1 -1
- package/dist-types/commands/ListAttachedFilesConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListAuthenticationProfilesCommand.d.ts +2 -2
- package/dist-types/commands/ListBotsCommand.d.ts +1 -1
- package/dist-types/commands/ListContactEvaluationsCommand.d.ts +1 -1
- package/dist-types/commands/ListContactFlowModulesCommand.d.ts +1 -1
- package/dist-types/commands/ListContactFlowVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListContactFlowsCommand.d.ts +3 -3
- package/dist-types/commands/ListContactReferencesCommand.d.ts +1 -1
- package/dist-types/commands/ListDefaultVocabulariesCommand.d.ts +1 -1
- package/dist-types/commands/ListEvaluationFormVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListEvaluationFormsCommand.d.ts +1 -1
- package/dist-types/commands/ListHoursOfOperationsCommand.d.ts +2 -2
- package/dist-types/commands/ListInstanceAttributesCommand.d.ts +1 -1
- package/dist-types/commands/ListInstanceStorageConfigsCommand.d.ts +1 -1
- package/dist-types/commands/ListInstancesCommand.d.ts +1 -1
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/ListLambdaFunctionsCommand.d.ts +1 -1
- package/dist-types/commands/ListLexBotsCommand.d.ts +1 -1
- package/dist-types/commands/ListPhoneNumbersCommand.d.ts +2 -2
- package/dist-types/commands/ListPhoneNumbersV2Command.d.ts +2 -2
- package/dist-types/commands/ListPredefinedAttributesCommand.d.ts +3 -3
- package/dist-types/commands/ListPromptsCommand.d.ts +1 -1
- package/dist-types/commands/ListQueuesCommand.d.ts +2 -2
- package/dist-types/commands/ListQuickConnectsCommand.d.ts +1 -1
- package/dist-types/commands/ListRoutingProfileManualAssignmentQueuesCommand.d.ts +2 -2
- package/dist-types/commands/ListRoutingProfilesCommand.d.ts +2 -2
- package/dist-types/commands/ListRulesCommand.d.ts +1 -1
- package/dist-types/commands/ListSecurityKeysCommand.d.ts +1 -1
- package/dist-types/commands/ListSecurityProfilePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/ListSecurityProfilesCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/ListTaskTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListUserHierarchyGroupsCommand.d.ts +2 -2
- package/dist-types/commands/ListUsersCommand.d.ts +1 -1
- package/dist-types/commands/ListViewVersionsCommand.d.ts +1 -1
- package/dist-types/commands/PutUserStatusCommand.d.ts +2 -2
- package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +2 -2
- package/dist-types/commands/ReplicateInstanceCommand.d.ts +4 -4
- package/dist-types/commands/SearchAgentStatusesCommand.d.ts +1 -1
- package/dist-types/commands/SearchAvailablePhoneNumbersCommand.d.ts +1 -1
- package/dist-types/commands/SearchContactEvaluationsCommand.d.ts +2 -2
- package/dist-types/commands/SearchContactFlowModulesCommand.d.ts +1 -1
- package/dist-types/commands/SearchContactFlowsCommand.d.ts +1 -1
- package/dist-types/commands/SearchContactsCommand.d.ts +1 -1
- package/dist-types/commands/SearchEvaluationFormsCommand.d.ts +2 -2
- package/dist-types/commands/SearchHoursOfOperationsCommand.d.ts +1 -1
- package/dist-types/commands/SearchPredefinedAttributesCommand.d.ts +2 -2
- package/dist-types/commands/SearchPromptsCommand.d.ts +1 -1
- package/dist-types/commands/SearchQueuesCommand.d.ts +1 -1
- package/dist-types/commands/SearchQuickConnectsCommand.d.ts +1 -1
- package/dist-types/commands/SearchResourceTagsCommand.d.ts +1 -1
- package/dist-types/commands/SearchRoutingProfilesCommand.d.ts +1 -1
- package/dist-types/commands/SearchSecurityProfilesCommand.d.ts +2 -2
- package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +1 -1
- package/dist-types/commands/SearchUsersCommand.d.ts +1 -1
- package/dist-types/commands/SearchVocabulariesCommand.d.ts +1 -1
- package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +1 -1
- package/dist-types/commands/SendOutboundEmailCommand.d.ts +2 -2
- package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +1 -1
- package/dist-types/commands/StartChatContactCommand.d.ts +4 -4
- package/dist-types/commands/StartContactEvaluationCommand.d.ts +1 -1
- package/dist-types/commands/StartContactStreamingCommand.d.ts +4 -4
- package/dist-types/commands/StartOutboundChatContactCommand.d.ts +2 -2
- package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +3 -3
- package/dist-types/commands/StartScreenSharingCommand.d.ts +1 -1
- package/dist-types/commands/StartTaskContactCommand.d.ts +5 -5
- package/dist-types/commands/StartWebRTCContactCommand.d.ts +1 -1
- package/dist-types/commands/SubmitContactEvaluationCommand.d.ts +1 -1
- package/dist-types/commands/TagContactCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UntagContactCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAttachedFilesConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAuthenticationProfileCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactAttributesCommand.d.ts +3 -3
- package/dist-types/commands/UpdateContactCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactEvaluationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactFlowModuleContentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactFlowNameCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEmailAddressMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/UpdateInstanceAttributeCommand.d.ts +1 -1
- package/dist-types/commands/UpdateInstanceStorageConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateParticipantAuthenticationCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePredefinedAttributeCommand.d.ts +3 -3
- package/dist-types/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRuleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSecurityProfileCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTaskTemplateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTrafficDistributionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserIdentityInfoCommand.d.ts +1 -1
- package/dist-types/commands/UpdateViewContentCommand.d.ts +1 -1
- package/dist-types/index.d.ts +8 -8
- package/dist-types/models/errors.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +106 -106
- package/dist-types/models/models_1.d.ts +150 -150
- package/dist-types/models/models_2.d.ts +100 -100
- package/dist-types/models/models_3.d.ts +188 -188
- package/package.json +3 -3
|
@@ -29,7 +29,7 @@ declare const DeactivateEvaluationFormCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Deactivates an evaluation form in the specified
|
|
32
|
+
* <p>Deactivates an evaluation form in the specified Connect Customer instance. After a form is deactivated, it is no longer
|
|
33
33
|
* available for users to start new evaluations based on the form. </p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ declare const DeleteContactEvaluationCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Deletes a contact evaluation in the specified
|
|
32
|
+
* <p>Deletes a contact evaluation in the specified Connect Customer instance.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -29,7 +29,7 @@ declare const DeleteContactFlowCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Deletes a flow for the specified
|
|
32
|
+
* <p>Deletes a flow for the specified Connect Customer instance.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -29,7 +29,7 @@ declare const DeleteEmailAddressCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Deletes email address from the specified
|
|
32
|
+
* <p>Deletes email address from the specified Connect Customer instance.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -29,7 +29,7 @@ declare const DeleteEvaluationFormCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Deletes an evaluation form in the specified
|
|
32
|
+
* <p>Deletes an evaluation form in the specified Connect Customer instance. </p>
|
|
33
33
|
* <ul>
|
|
34
34
|
* <li>
|
|
35
35
|
* <p>If the version property is provided, only the specified version of the evaluation form is deleted.</p>
|
|
@@ -29,7 +29,7 @@ declare const DeleteHoursOfOperationOverrideCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Deletes an hours of operation override in an
|
|
32
|
+
* <p>Deletes an hours of operation override in an Connect Customer hours of operation resource.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -29,10 +29,10 @@ declare const DeleteInstanceCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>This API is in preview release for
|
|
33
|
-
* <p>Deletes the
|
|
34
|
-
* <i>
|
|
35
|
-
* <p>
|
|
32
|
+
* <p>This API is in preview release for Connect Customer and is subject to change.</p>
|
|
33
|
+
* <p>Deletes the Connect Customer instance. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-connect-instance.html">Delete your Connect Customer instance</a> in the
|
|
34
|
+
* <i>Connect Customer Administrator Guide</i>.</p>
|
|
35
|
+
* <p>Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days.
|
|
36
36
|
* If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances.
|
|
37
37
|
* You must wait 30 days before you can restart creating and deleting instances in your account.</p>
|
|
38
38
|
* @example
|
|
@@ -29,7 +29,7 @@ declare const DeleteIntegrationAssociationCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Deletes an Amazon Web Services resource association from an
|
|
32
|
+
* <p>Deletes an Amazon Web Services resource association from an Connect Customer instance. The association must not
|
|
33
33
|
* have any use cases associated with it.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ declare const DeletePredefinedAttributeCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Deletes a predefined attribute from the specified
|
|
32
|
+
* <p>Deletes a predefined attribute from the specified Connect Customer instance.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -41,8 +41,8 @@ declare const DeleteQuickConnectCommand_base: {
|
|
|
41
41
|
* <p>Remove deleted users so they don't appear to agents as transfer options.</p>
|
|
42
42
|
* </li>
|
|
43
43
|
* <li>
|
|
44
|
-
* <p>Avoid the disruption of other
|
|
45
|
-
* you're using <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html">
|
|
44
|
+
* <p>Avoid the disruption of other Connect Customer processes, such as instance replication and syncing if
|
|
45
|
+
* you're using <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html">Connect Customer Global Resiliency</a>. </p>
|
|
46
46
|
* </li>
|
|
47
47
|
* </ul>
|
|
48
48
|
* </important>
|
|
@@ -29,7 +29,7 @@ declare const DeleteRuleCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Deletes a rule for the specified
|
|
32
|
+
* <p>Deletes a rule for the specified Connect Customer instance.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -31,7 +31,7 @@ declare const DeleteTrafficDistributionGroupCommand_base: {
|
|
|
31
31
|
/**
|
|
32
32
|
* <p>Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.</p>
|
|
33
33
|
* <p>For more information about deleting traffic distribution groups, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html">Delete traffic distribution groups</a> in the
|
|
34
|
-
* <i>
|
|
34
|
+
* <i>Connect Customer Administrator Guide</i>.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -29,9 +29,9 @@ declare const DeleteUserCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Deletes a user account from the specified
|
|
33
|
-
* <p>For information about what happens to a user's data when their account is deleted, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html">Delete Users from Your
|
|
34
|
-
* Instance</a> in the <i>
|
|
32
|
+
* <p>Deletes a user account from the specified Connect Customer instance.</p>
|
|
33
|
+
* <p>For information about what happens to a user's data when their account is deleted, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html">Delete Users from Your Connect Customer
|
|
34
|
+
* Instance</a> in the <i>Connect Customer Administrator Guide</i>.</p>
|
|
35
35
|
* <important>
|
|
36
36
|
* <p>After calling DeleteUser, call <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteQuickConnect.html">DeleteQuickConnect</a> to delete any records
|
|
37
37
|
* related to the deleted users. This will help you:</p>
|
|
@@ -43,8 +43,8 @@ declare const DeleteUserCommand_base: {
|
|
|
43
43
|
* <p>Remove deleted users so they don't appear to agents as transfer options.</p>
|
|
44
44
|
* </li>
|
|
45
45
|
* <li>
|
|
46
|
-
* <p>Avoid the disruption of other
|
|
47
|
-
* you're using <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html">
|
|
46
|
+
* <p>Avoid the disruption of other Connect Customer processes, such as instance replication and syncing if
|
|
47
|
+
* you're using <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html">Connect Customer Global Resiliency</a>. </p>
|
|
48
48
|
* </li>
|
|
49
49
|
* </ul>
|
|
50
50
|
* </important>
|
|
@@ -29,7 +29,7 @@ declare const DescribeAttachedFilesConfigurationCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Describes the attached files configuration for the specified
|
|
32
|
+
* <p>Describes the attached files configuration for the specified Connect Customer instance and attachment scope.</p>
|
|
33
33
|
* <p>If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ declare const DescribeAuthenticationProfileCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>This API is in preview release for
|
|
32
|
+
* <p>This API is in preview release for Connect Customer and is subject to change. To
|
|
33
33
|
* request access to this API, contact Amazon Web Services Support.</p>
|
|
34
34
|
* <p>Describes the target authentication profile.</p>
|
|
35
35
|
* @example
|
|
@@ -30,7 +30,7 @@ declare const DescribeContactCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
};
|
|
32
32
|
/**
|
|
33
|
-
* <p>This API is in preview release for
|
|
33
|
+
* <p>This API is in preview release for Connect Customer and is subject to change.</p>
|
|
34
34
|
* <p>Describes the specified contact. </p>
|
|
35
35
|
* <p>
|
|
36
36
|
* <b>Use cases</b>
|
|
@@ -62,12 +62,12 @@ declare const DescribeContactCommand_base: {
|
|
|
62
62
|
* or CALLBACK</p>
|
|
63
63
|
* </li>
|
|
64
64
|
* <li>
|
|
65
|
-
* <p>Contact information remains available in
|
|
66
|
-
* <code>InitiationTimestamp</code>, and then it is deleted. Only contact information that is available in
|
|
65
|
+
* <p>Contact information remains available in Connect Customer for 24 months from the
|
|
66
|
+
* <code>InitiationTimestamp</code>, and then it is deleted. Only contact information that is available in Connect Customer is returned by this API.</p>
|
|
67
67
|
* </li>
|
|
68
68
|
* </ul>
|
|
69
69
|
* <p>
|
|
70
|
-
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">
|
|
70
|
+
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Connect Customer endpoints and quotas</a>.</p>
|
|
71
71
|
* @example
|
|
72
72
|
* Use a bare-bones client and the command you need to make an API call.
|
|
73
73
|
* ```javascript
|
|
@@ -30,7 +30,7 @@ declare const DescribeContactEvaluationCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
};
|
|
32
32
|
/**
|
|
33
|
-
* <p>Describes a contact evaluation in the specified
|
|
33
|
+
* <p>Describes a contact evaluation in the specified Connect Customer instance.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
36
|
* ```javascript
|
|
@@ -30,7 +30,7 @@ declare const DescribeContactFlowCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
32
|
* <p>Describes the specified flow.</p>
|
|
33
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">
|
|
33
|
+
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Connect Customer
|
|
34
34
|
* Flow language</a>.</p>
|
|
35
35
|
* <p>Use the <code>$SAVED</code> alias in the request to describe the <code>SAVED</code> content of a Flow. For
|
|
36
36
|
* example, <code>arn:aws:.../contact-flow/\{id\}:$SAVED</code>. After a flow is published, <code>$SAVED</code> needs to
|
|
@@ -29,7 +29,7 @@ declare const DescribeEmailAddressCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Describe email address form the specified
|
|
32
|
+
* <p>Describe email address form the specified Connect Customer instance.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -30,7 +30,7 @@ declare const DescribeEvaluationFormCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
};
|
|
32
32
|
/**
|
|
33
|
-
* <p>Describes an evaluation form in the specified
|
|
33
|
+
* <p>Describes an evaluation form in the specified Connect Customer instance. If the version property is not
|
|
34
34
|
* provided, the latest version of the evaluation form is described.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ declare const DescribeInstanceAttributeCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>This API is in preview release for
|
|
32
|
+
* <p>This API is in preview release for Connect Customer and is subject to change.</p>
|
|
33
33
|
* <p>Describes the specified instance attribute.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ declare const DescribeInstanceCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>This API is in preview release for
|
|
32
|
+
* <p>This API is in preview release for Connect Customer and is subject to change.</p>
|
|
33
33
|
* <p>Returns the current state of the specified instance identifier. It tracks the instance while it is being created
|
|
34
34
|
* and returns an error status, if applicable. </p>
|
|
35
35
|
* <p>If an instance is not created successfully, the instance status reason field returns details relevant to the
|
|
@@ -29,7 +29,7 @@ declare const DescribeInstanceStorageConfigCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>This API is in preview release for
|
|
32
|
+
* <p>This API is in preview release for Connect Customer and is subject to change.</p>
|
|
33
33
|
* <p>Retrieves the current storage configurations for the specified resource type, association ID, and instance
|
|
34
34
|
* ID.</p>
|
|
35
35
|
* @example
|
|
@@ -29,7 +29,7 @@ declare const DescribePhoneNumberCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Gets details and status of a phone number that’s claimed to your
|
|
32
|
+
* <p>Gets details and status of a phone number that’s claimed to your Connect Customer instance or traffic distribution group.</p>
|
|
33
33
|
* <important>
|
|
34
34
|
* <p>If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was
|
|
35
35
|
* created, you can use either a phone number ARN or UUID value for the <code>PhoneNumberId</code> URI request
|
|
@@ -29,7 +29,7 @@ declare const DescribePredefinedAttributeCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Describes a predefined attribute for the specified
|
|
32
|
+
* <p>Describes a predefined attribute for the specified Connect Customer instance. A <i>predefined attribute</i>
|
|
33
33
|
* is made up of a name and a value. You can use predefined attributes for:</p>
|
|
34
34
|
* <ul>
|
|
35
35
|
* <li>
|
|
@@ -42,10 +42,10 @@ declare const DescribePredefinedAttributeCommand_base: {
|
|
|
42
42
|
* handling the contact. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p>
|
|
43
43
|
* </li>
|
|
44
44
|
* </ul>
|
|
45
|
-
* <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">
|
|
45
|
+
* <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Connect Customer
|
|
46
46
|
* quotas</a>.</p>
|
|
47
47
|
* <p>
|
|
48
|
-
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">
|
|
48
|
+
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Connect Customer endpoints and quotas</a>.</p>
|
|
49
49
|
* @example
|
|
50
50
|
* Use a bare-bones client and the command you need to make an API call.
|
|
51
51
|
* ```javascript
|
|
@@ -29,7 +29,7 @@ declare const DescribeRuleCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Describes a rule for the specified
|
|
32
|
+
* <p>Describes a rule for the specified Connect Customer instance.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -30,7 +30,7 @@ declare const DescribeSecurityProfileCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
32
|
* <p>Gets basic information about the security profile.</p>
|
|
33
|
-
* <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the <i>
|
|
33
|
+
* <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the <i>Connect Customer Administrator Guide</i>. For a mapping of the API name and user interface name of the security
|
|
34
34
|
* profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List
|
|
35
35
|
* of security profile permissions</a>. </p>
|
|
36
36
|
* @example
|
|
@@ -29,7 +29,7 @@ declare const DescribeUserCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Describes the specified user. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID in the
|
|
32
|
+
* <p>Describes the specified user. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID in the Connect Customer
|
|
33
33
|
* console</a> (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users
|
|
34
34
|
* and note the IDs provided in the output.</p>
|
|
35
35
|
* @example
|
|
@@ -29,7 +29,7 @@ declare const DescribeUserHierarchyStructureCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Describes the hierarchy structure of the specified
|
|
32
|
+
* <p>Describes the hierarchy structure of the specified Connect Customer instance.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -29,12 +29,12 @@ declare const DescribeViewCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Retrieves the view for the specified
|
|
32
|
+
* <p>Retrieves the view for the specified Connect Customer instance and view identifier.</p>
|
|
33
33
|
* <p>The view identifier can be supplied as a ViewId or ARN.</p>
|
|
34
34
|
* <p>
|
|
35
35
|
* <code>$SAVED</code> needs to be supplied if a view is unpublished.</p>
|
|
36
36
|
* <p>The view identifier can contain an optional qualifier, for example, <code><view-id>:$SAVED</code>, which
|
|
37
|
-
* is either an actual version number or an
|
|
37
|
+
* is either an actual version number or an Connect Customer managed qualifier <code>$SAVED | $LATEST</code>. If it is
|
|
38
38
|
* not supplied, then <code>$LATEST</code> is assumed for customer managed views and an error is returned if there is no
|
|
39
39
|
* published content available. Version 1 is assumed for Amazon Web Services managed views.</p>
|
|
40
40
|
* @example
|
|
@@ -29,7 +29,7 @@ declare const DisassociateAnalyticsDataSetCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Removes the dataset ID associated with a given
|
|
32
|
+
* <p>Removes the dataset ID associated with a given Connect Customer instance.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -29,8 +29,8 @@ declare const DisassociateApprovedOriginCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>This API is in preview release for
|
|
33
|
-
* <p>Revokes access to integrated applications from
|
|
32
|
+
* <p>This API is in preview release for Connect Customer and is subject to change.</p>
|
|
33
|
+
* <p>Revokes access to integrated applications from Connect Customer.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
36
|
* ```javascript
|
|
@@ -29,7 +29,7 @@ declare const DisassociateBotCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>This API is in preview release for
|
|
32
|
+
* <p>This API is in preview release for Connect Customer and is subject to change.</p>
|
|
33
33
|
* <p>Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot. </p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ declare const DisassociateEmailAddressAliasCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Removes the alias association between two email addresses in an
|
|
32
|
+
* <p>Removes the alias association between two email addresses in an Connect Customer instance. After
|
|
33
33
|
* disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address.
|
|
34
34
|
* Both email addresses continue to exist independently and can receive emails directly.</p>
|
|
35
35
|
* <p>
|
|
@@ -87,7 +87,7 @@ declare const DisassociateEmailAddressAliasCommand_base: {
|
|
|
87
87
|
* </li>
|
|
88
88
|
* </ul>
|
|
89
89
|
* <p>
|
|
90
|
-
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">
|
|
90
|
+
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Connect Customer endpoints and quotas</a>.</p>
|
|
91
91
|
* <p>
|
|
92
92
|
* <b>Related operations</b>
|
|
93
93
|
* </p>
|
|
@@ -95,7 +95,7 @@ declare const DisassociateEmailAddressAliasCommand_base: {
|
|
|
95
95
|
* <li>
|
|
96
96
|
* <p>
|
|
97
97
|
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_AssociateEmailAddressAlias.html">AssociateEmailAddressAlias</a>: Associates an email address alias with an existing email address in an
|
|
98
|
-
*
|
|
98
|
+
* Connect Customer instance.</p>
|
|
99
99
|
* </li>
|
|
100
100
|
* <li>
|
|
101
101
|
* <p>
|
|
@@ -29,7 +29,7 @@ declare const DisassociateInstanceStorageConfigCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>This API is in preview release for
|
|
32
|
+
* <p>This API is in preview release for Connect Customer and is subject to change.</p>
|
|
33
33
|
* <p>Removes the storage type configurations for the specified resource type and association ID.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ declare const DisassociateLambdaFunctionCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>This API is in preview release for
|
|
32
|
+
* <p>This API is in preview release for Connect Customer and is subject to change.</p>
|
|
33
33
|
* <p>Remove the Lambda function from the dropdown options available in the relevant flow blocks.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ declare const DisassociateLexBotCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>This API is in preview release for
|
|
32
|
+
* <p>This API is in preview release for Connect Customer and is subject to change.</p>
|
|
33
33
|
* <p>Revokes authorization from the specified instance to access the specified Amazon Lex bot.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ declare const DisassociatePhoneNumberContactFlowCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Removes the flow association from a phone number claimed to your
|
|
32
|
+
* <p>Removes the flow association from a phone number claimed to your Connect Customer instance.</p>
|
|
33
33
|
* <important>
|
|
34
34
|
* <p>If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the
|
|
35
35
|
* <code>PhoneNumberId</code> URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling
|
|
@@ -29,7 +29,7 @@ declare const DisassociateSecurityKeyCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>This API is in preview release for
|
|
32
|
+
* <p>This API is in preview release for Connect Customer and is subject to change.</p>
|
|
33
33
|
* <p>Deletes the specified security key.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -60,11 +60,11 @@ declare const GetContactMetricsCommand_base: {
|
|
|
60
60
|
* <p>Metrics are only available while the contact is actively in queue.</p>
|
|
61
61
|
* </li>
|
|
62
62
|
* <li>
|
|
63
|
-
* <p>For more information, see the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Position in queue</a> metric in the <i>
|
|
63
|
+
* <p>For more information, see the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Position in queue</a> metric in the <i>Connect Customer Administrator Guide</i>. </p>
|
|
64
64
|
* </li>
|
|
65
65
|
* </ul>
|
|
66
66
|
* <p>
|
|
67
|
-
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">
|
|
67
|
+
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Connect Customer endpoints and quotas</a>.</p>
|
|
68
68
|
* @example
|
|
69
69
|
* Use a bare-bones client and the command you need to make an API call.
|
|
70
70
|
* ```javascript
|
|
@@ -29,8 +29,8 @@ declare const GetCurrentMetricDataCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Gets the real-time metric data from the specified
|
|
33
|
-
* <p>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>
|
|
32
|
+
* <p>Gets the real-time metric data from the specified Connect Customer instance.</p>
|
|
33
|
+
* <p>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>
|
|
34
34
|
* <note>
|
|
35
35
|
* <p>When you make a successful API request, you can expect the following metric values in the response:</p>
|
|
36
36
|
* <ol>
|
|
@@ -29,7 +29,7 @@ declare const GetCurrentUserDataCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Gets the real-time active user data from the specified
|
|
32
|
+
* <p>Gets the real-time active user data from the specified Connect Customer instance. </p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -29,15 +29,15 @@ declare const GetFederationTokenCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Supports SAML sign-in for
|
|
33
|
-
* <p>For more information about how SAML sign-in works in
|
|
34
|
-
* in the <i>
|
|
32
|
+
* <p>Supports SAML sign-in for Connect Customer. Retrieves a token for federation. The token is for the Connect Customer user which corresponds to the IAM credentials that were used to invoke this action. </p>
|
|
33
|
+
* <p>For more information about how SAML sign-in works in Connect Customer, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/configure-saml.html ">Configure SAML with IAM for Connect Customer
|
|
34
|
+
* in the <i>Connect Customer Administrator Guide</i>.</a>
|
|
35
35
|
* </p>
|
|
36
36
|
* <note>
|
|
37
37
|
* <p>This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error
|
|
38
38
|
* message similar to the following one appears: </p>
|
|
39
39
|
* <p>
|
|
40
|
-
* <code>Provided identity: Principal: .... User: .... cannot be used for federation with
|
|
40
|
+
* <code>Provided identity: Principal: .... User: .... cannot be used for federation with Connect Customer</code>
|
|
41
41
|
* </p>
|
|
42
42
|
* </note>
|
|
43
43
|
* @example
|
|
@@ -89,7 +89,7 @@ declare const GetFederationTokenCommand_base: {
|
|
|
89
89
|
* <p>The specified resource was not found.</p>
|
|
90
90
|
*
|
|
91
91
|
* @throws {@link UserNotFoundException} (client fault)
|
|
92
|
-
* <p>No user with the specified credentials was found in the
|
|
92
|
+
* <p>No user with the specified credentials was found in the Connect Customer instance.</p>
|
|
93
93
|
*
|
|
94
94
|
* @throws {@link ConnectServiceException}
|
|
95
95
|
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
@@ -29,8 +29,8 @@ declare const GetMetricDataCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Gets historical metric data from the specified
|
|
33
|
-
* <p>For a description of each historical metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definitions</a> in the <i>
|
|
32
|
+
* <p>Gets historical metric data from the specified Connect Customer instance.</p>
|
|
33
|
+
* <p>For a description of each historical 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>
|
|
34
34
|
* <note>
|
|
35
35
|
* <p>We recommend using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html">GetMetricDataV2</a> API. It provides more flexibility, features, and the ability to query longer time ranges
|
|
36
36
|
* than <code>GetMetricData</code>. Use it to retrieve historical agent and contact metrics for the last 3 months, at
|
|
@@ -29,14 +29,14 @@ declare const GetMetricDataV2Command_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Gets metric data from the specified
|
|
32
|
+
* <p>Gets metric data from the specified Connect Customer instance. </p>
|
|
33
33
|
* <p>
|
|
34
34
|
* <code>GetMetricDataV2</code> offers more features than <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricData.html">GetMetricData</a>, the previous version of this API. It
|
|
35
35
|
* has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels,
|
|
36
36
|
* queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months,
|
|
37
37
|
* at varying intervals. It does not support agent queues.</p>
|
|
38
38
|
* <p>For a description of the historical metrics that are supported by <code>GetMetricDataV2</code> and
|
|
39
|
-
* <code>GetMetricData</code>, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definitions</a> in the <i>
|
|
39
|
+
* <code>GetMetricData</code>, 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>
|
|
40
40
|
* <note>
|
|
41
41
|
* <p>When you make a successful API request, you can expect the following metric values in the response:</p>
|
|
42
42
|
* <ol>
|
|
@@ -29,7 +29,7 @@ declare const GetTaskTemplateCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Gets details about a specific task template in the specified
|
|
32
|
+
* <p>Gets details about a specific task template in the specified Connect Customer instance.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -30,7 +30,7 @@ declare const ImportPhoneNumberCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
32
|
* <p>Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an
|
|
33
|
-
*
|
|
33
|
+
* Connect Customer instance. You can call this API only in the same Amazon Web Services Region where the Connect Customer instance was created.</p>
|
|
34
34
|
* <important>
|
|
35
35
|
* <p>Call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html">DescribePhoneNumber</a> API to verify the status of a previous <code>ImportPhoneNumber</code> operation.
|
|
36
36
|
* </p>
|