@aws-sdk/client-connect 3.431.0 → 3.435.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 +11 -3
- package/dist-cjs/Connect.js +2 -0
- package/dist-cjs/commands/UpdatePhoneNumberMetadataCommand.js +51 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/protocols/Aws_restJson1.js +80 -6
- package/dist-es/Connect.js +2 -0
- package/dist-es/commands/UpdatePhoneNumberMetadataCommand.js +47 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/protocols/Aws_restJson1.js +72 -0
- package/dist-types/Connect.d.ts +10 -3
- package/dist-types/ConnectClient.d.ts +6 -5
- package/dist-types/commands/CreateTrafficDistributionGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserCommand.d.ts +6 -0
- package/dist-types/commands/GetFederationTokenCommand.d.ts +7 -1
- package/dist-types/commands/GetMetricDataCommand.d.ts +9 -0
- package/dist-types/commands/SearchUsersCommand.d.ts +1 -1
- package/dist-types/commands/StartTaskContactCommand.d.ts +51 -1
- package/dist-types/commands/UpdatePhoneNumberMetadataCommand.d.ts +100 -0
- package/dist-types/commands/UpdateTrafficDistributionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +23 -29
- package/dist-types/models/models_1.d.ts +36 -20
- package/dist-types/models/models_2.d.ts +28 -1
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/Connect.d.ts +17 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/UpdatePhoneNumberMetadataCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_1.d.ts +3 -3
- package/dist-types/ts3.4/models/models_2.d.ts +5 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +32 -32
|
@@ -192,6 +192,7 @@ import { UpdateInstanceAttributeCommandInput, UpdateInstanceAttributeCommandOutp
|
|
|
192
192
|
import { UpdateInstanceStorageConfigCommandInput, UpdateInstanceStorageConfigCommandOutput } from "./commands/UpdateInstanceStorageConfigCommand";
|
|
193
193
|
import { UpdateParticipantRoleConfigCommandInput, UpdateParticipantRoleConfigCommandOutput } from "./commands/UpdateParticipantRoleConfigCommand";
|
|
194
194
|
import { UpdatePhoneNumberCommandInput, UpdatePhoneNumberCommandOutput } from "./commands/UpdatePhoneNumberCommand";
|
|
195
|
+
import { UpdatePhoneNumberMetadataCommandInput, UpdatePhoneNumberMetadataCommandOutput } from "./commands/UpdatePhoneNumberMetadataCommand";
|
|
195
196
|
import { UpdatePromptCommandInput, UpdatePromptCommandOutput } from "./commands/UpdatePromptCommand";
|
|
196
197
|
import { UpdateQueueHoursOfOperationCommandInput, UpdateQueueHoursOfOperationCommandOutput } from "./commands/UpdateQueueHoursOfOperationCommand";
|
|
197
198
|
import { UpdateQueueMaxContactsCommandInput, UpdateQueueMaxContactsCommandOutput } from "./commands/UpdateQueueMaxContactsCommand";
|
|
@@ -224,11 +225,11 @@ export { __Client };
|
|
|
224
225
|
/**
|
|
225
226
|
* @public
|
|
226
227
|
*/
|
|
227
|
-
export type ServiceInputTypes = ActivateEvaluationFormCommandInput | AssociateApprovedOriginCommandInput | AssociateBotCommandInput | AssociateDefaultVocabularyCommandInput | AssociateInstanceStorageConfigCommandInput | AssociateLambdaFunctionCommandInput | AssociateLexBotCommandInput | AssociatePhoneNumberContactFlowCommandInput | AssociateQueueQuickConnectsCommandInput | AssociateRoutingProfileQueuesCommandInput | AssociateSecurityKeyCommandInput | AssociateTrafficDistributionGroupUserCommandInput | ClaimPhoneNumberCommandInput | CreateAgentStatusCommandInput | CreateContactFlowCommandInput | CreateContactFlowModuleCommandInput | CreateEvaluationFormCommandInput | CreateHoursOfOperationCommandInput | CreateInstanceCommandInput | CreateIntegrationAssociationCommandInput | CreateParticipantCommandInput | CreatePromptCommandInput | CreateQueueCommandInput | CreateQuickConnectCommandInput | CreateRoutingProfileCommandInput | CreateRuleCommandInput | CreateSecurityProfileCommandInput | CreateTaskTemplateCommandInput | CreateTrafficDistributionGroupCommandInput | CreateUseCaseCommandInput | CreateUserCommandInput | CreateUserHierarchyGroupCommandInput | CreateViewCommandInput | CreateViewVersionCommandInput | CreateVocabularyCommandInput | DeactivateEvaluationFormCommandInput | DeleteContactEvaluationCommandInput | DeleteContactFlowCommandInput | DeleteContactFlowModuleCommandInput | DeleteEvaluationFormCommandInput | DeleteHoursOfOperationCommandInput | DeleteInstanceCommandInput | DeleteIntegrationAssociationCommandInput | DeletePromptCommandInput | DeleteQueueCommandInput | DeleteQuickConnectCommandInput | DeleteRoutingProfileCommandInput | DeleteRuleCommandInput | DeleteSecurityProfileCommandInput | DeleteTaskTemplateCommandInput | DeleteTrafficDistributionGroupCommandInput | DeleteUseCaseCommandInput | DeleteUserCommandInput | DeleteUserHierarchyGroupCommandInput | DeleteViewCommandInput | DeleteViewVersionCommandInput | DeleteVocabularyCommandInput | DescribeAgentStatusCommandInput | DescribeContactCommandInput | DescribeContactEvaluationCommandInput | DescribeContactFlowCommandInput | DescribeContactFlowModuleCommandInput | DescribeEvaluationFormCommandInput | DescribeHoursOfOperationCommandInput | DescribeInstanceAttributeCommandInput | DescribeInstanceCommandInput | DescribeInstanceStorageConfigCommandInput | DescribePhoneNumberCommandInput | DescribePromptCommandInput | DescribeQueueCommandInput | DescribeQuickConnectCommandInput | DescribeRoutingProfileCommandInput | DescribeRuleCommandInput | DescribeSecurityProfileCommandInput | DescribeTrafficDistributionGroupCommandInput | DescribeUserCommandInput | DescribeUserHierarchyGroupCommandInput | DescribeUserHierarchyStructureCommandInput | DescribeViewCommandInput | DescribeVocabularyCommandInput | DisassociateApprovedOriginCommandInput | DisassociateBotCommandInput | DisassociateInstanceStorageConfigCommandInput | DisassociateLambdaFunctionCommandInput | DisassociateLexBotCommandInput | DisassociatePhoneNumberContactFlowCommandInput | DisassociateQueueQuickConnectsCommandInput | DisassociateRoutingProfileQueuesCommandInput | DisassociateSecurityKeyCommandInput | DisassociateTrafficDistributionGroupUserCommandInput | DismissUserContactCommandInput | GetContactAttributesCommandInput | GetCurrentMetricDataCommandInput | GetCurrentUserDataCommandInput | GetFederationTokenCommandInput | GetMetricDataCommandInput | GetMetricDataV2CommandInput | GetPromptFileCommandInput | GetTaskTemplateCommandInput | GetTrafficDistributionCommandInput | ListAgentStatusesCommandInput | ListApprovedOriginsCommandInput | ListBotsCommandInput | ListContactEvaluationsCommandInput | ListContactFlowModulesCommandInput | ListContactFlowsCommandInput | ListContactReferencesCommandInput | ListDefaultVocabulariesCommandInput | ListEvaluationFormVersionsCommandInput | ListEvaluationFormsCommandInput | ListHoursOfOperationsCommandInput | ListInstanceAttributesCommandInput | ListInstanceStorageConfigsCommandInput | ListInstancesCommandInput | ListIntegrationAssociationsCommandInput | ListLambdaFunctionsCommandInput | ListLexBotsCommandInput | ListPhoneNumbersCommandInput | ListPhoneNumbersV2CommandInput | ListPromptsCommandInput | ListQueueQuickConnectsCommandInput | ListQueuesCommandInput | ListQuickConnectsCommandInput | ListRoutingProfileQueuesCommandInput | ListRoutingProfilesCommandInput | ListRulesCommandInput | ListSecurityKeysCommandInput | ListSecurityProfileApplicationsCommandInput | ListSecurityProfilePermissionsCommandInput | ListSecurityProfilesCommandInput | ListTagsForResourceCommandInput | ListTaskTemplatesCommandInput | ListTrafficDistributionGroupUsersCommandInput | ListTrafficDistributionGroupsCommandInput | ListUseCasesCommandInput | ListUserHierarchyGroupsCommandInput | ListUsersCommandInput | ListViewVersionsCommandInput | ListViewsCommandInput | MonitorContactCommandInput | PutUserStatusCommandInput | ReleasePhoneNumberCommandInput | ReplicateInstanceCommandInput | ResumeContactRecordingCommandInput | SearchAvailablePhoneNumbersCommandInput | SearchHoursOfOperationsCommandInput | SearchPromptsCommandInput | SearchQueuesCommandInput | SearchQuickConnectsCommandInput | SearchResourceTagsCommandInput | SearchRoutingProfilesCommandInput | SearchSecurityProfilesCommandInput | SearchUsersCommandInput | SearchVocabulariesCommandInput | StartChatContactCommandInput | StartContactEvaluationCommandInput | StartContactRecordingCommandInput | StartContactStreamingCommandInput | StartOutboundVoiceContactCommandInput | StartTaskContactCommandInput | StopContactCommandInput | StopContactRecordingCommandInput | StopContactStreamingCommandInput | SubmitContactEvaluationCommandInput | SuspendContactRecordingCommandInput | TagResourceCommandInput | TransferContactCommandInput | UntagResourceCommandInput | UpdateAgentStatusCommandInput | UpdateContactAttributesCommandInput | UpdateContactCommandInput | UpdateContactEvaluationCommandInput | UpdateContactFlowContentCommandInput | UpdateContactFlowMetadataCommandInput | UpdateContactFlowModuleContentCommandInput | UpdateContactFlowModuleMetadataCommandInput | UpdateContactFlowNameCommandInput | UpdateContactScheduleCommandInput | UpdateEvaluationFormCommandInput | UpdateHoursOfOperationCommandInput | UpdateInstanceAttributeCommandInput | UpdateInstanceStorageConfigCommandInput | UpdateParticipantRoleConfigCommandInput | UpdatePhoneNumberCommandInput | UpdatePromptCommandInput | UpdateQueueHoursOfOperationCommandInput | UpdateQueueMaxContactsCommandInput | UpdateQueueNameCommandInput | UpdateQueueOutboundCallerConfigCommandInput | UpdateQueueStatusCommandInput | UpdateQuickConnectConfigCommandInput | UpdateQuickConnectNameCommandInput | UpdateRoutingProfileAgentAvailabilityTimerCommandInput | UpdateRoutingProfileConcurrencyCommandInput | UpdateRoutingProfileDefaultOutboundQueueCommandInput | UpdateRoutingProfileNameCommandInput | UpdateRoutingProfileQueuesCommandInput | UpdateRuleCommandInput | UpdateSecurityProfileCommandInput | UpdateTaskTemplateCommandInput | UpdateTrafficDistributionCommandInput | UpdateUserHierarchyCommandInput | UpdateUserHierarchyGroupNameCommandInput | UpdateUserHierarchyStructureCommandInput | UpdateUserIdentityInfoCommandInput | UpdateUserPhoneConfigCommandInput | UpdateUserRoutingProfileCommandInput | UpdateUserSecurityProfilesCommandInput | UpdateViewContentCommandInput | UpdateViewMetadataCommandInput;
|
|
228
|
+
export type ServiceInputTypes = ActivateEvaluationFormCommandInput | AssociateApprovedOriginCommandInput | AssociateBotCommandInput | AssociateDefaultVocabularyCommandInput | AssociateInstanceStorageConfigCommandInput | AssociateLambdaFunctionCommandInput | AssociateLexBotCommandInput | AssociatePhoneNumberContactFlowCommandInput | AssociateQueueQuickConnectsCommandInput | AssociateRoutingProfileQueuesCommandInput | AssociateSecurityKeyCommandInput | AssociateTrafficDistributionGroupUserCommandInput | ClaimPhoneNumberCommandInput | CreateAgentStatusCommandInput | CreateContactFlowCommandInput | CreateContactFlowModuleCommandInput | CreateEvaluationFormCommandInput | CreateHoursOfOperationCommandInput | CreateInstanceCommandInput | CreateIntegrationAssociationCommandInput | CreateParticipantCommandInput | CreatePromptCommandInput | CreateQueueCommandInput | CreateQuickConnectCommandInput | CreateRoutingProfileCommandInput | CreateRuleCommandInput | CreateSecurityProfileCommandInput | CreateTaskTemplateCommandInput | CreateTrafficDistributionGroupCommandInput | CreateUseCaseCommandInput | CreateUserCommandInput | CreateUserHierarchyGroupCommandInput | CreateViewCommandInput | CreateViewVersionCommandInput | CreateVocabularyCommandInput | DeactivateEvaluationFormCommandInput | DeleteContactEvaluationCommandInput | DeleteContactFlowCommandInput | DeleteContactFlowModuleCommandInput | DeleteEvaluationFormCommandInput | DeleteHoursOfOperationCommandInput | DeleteInstanceCommandInput | DeleteIntegrationAssociationCommandInput | DeletePromptCommandInput | DeleteQueueCommandInput | DeleteQuickConnectCommandInput | DeleteRoutingProfileCommandInput | DeleteRuleCommandInput | DeleteSecurityProfileCommandInput | DeleteTaskTemplateCommandInput | DeleteTrafficDistributionGroupCommandInput | DeleteUseCaseCommandInput | DeleteUserCommandInput | DeleteUserHierarchyGroupCommandInput | DeleteViewCommandInput | DeleteViewVersionCommandInput | DeleteVocabularyCommandInput | DescribeAgentStatusCommandInput | DescribeContactCommandInput | DescribeContactEvaluationCommandInput | DescribeContactFlowCommandInput | DescribeContactFlowModuleCommandInput | DescribeEvaluationFormCommandInput | DescribeHoursOfOperationCommandInput | DescribeInstanceAttributeCommandInput | DescribeInstanceCommandInput | DescribeInstanceStorageConfigCommandInput | DescribePhoneNumberCommandInput | DescribePromptCommandInput | DescribeQueueCommandInput | DescribeQuickConnectCommandInput | DescribeRoutingProfileCommandInput | DescribeRuleCommandInput | DescribeSecurityProfileCommandInput | DescribeTrafficDistributionGroupCommandInput | DescribeUserCommandInput | DescribeUserHierarchyGroupCommandInput | DescribeUserHierarchyStructureCommandInput | DescribeViewCommandInput | DescribeVocabularyCommandInput | DisassociateApprovedOriginCommandInput | DisassociateBotCommandInput | DisassociateInstanceStorageConfigCommandInput | DisassociateLambdaFunctionCommandInput | DisassociateLexBotCommandInput | DisassociatePhoneNumberContactFlowCommandInput | DisassociateQueueQuickConnectsCommandInput | DisassociateRoutingProfileQueuesCommandInput | DisassociateSecurityKeyCommandInput | DisassociateTrafficDistributionGroupUserCommandInput | DismissUserContactCommandInput | GetContactAttributesCommandInput | GetCurrentMetricDataCommandInput | GetCurrentUserDataCommandInput | GetFederationTokenCommandInput | GetMetricDataCommandInput | GetMetricDataV2CommandInput | GetPromptFileCommandInput | GetTaskTemplateCommandInput | GetTrafficDistributionCommandInput | ListAgentStatusesCommandInput | ListApprovedOriginsCommandInput | ListBotsCommandInput | ListContactEvaluationsCommandInput | ListContactFlowModulesCommandInput | ListContactFlowsCommandInput | ListContactReferencesCommandInput | ListDefaultVocabulariesCommandInput | ListEvaluationFormVersionsCommandInput | ListEvaluationFormsCommandInput | ListHoursOfOperationsCommandInput | ListInstanceAttributesCommandInput | ListInstanceStorageConfigsCommandInput | ListInstancesCommandInput | ListIntegrationAssociationsCommandInput | ListLambdaFunctionsCommandInput | ListLexBotsCommandInput | ListPhoneNumbersCommandInput | ListPhoneNumbersV2CommandInput | ListPromptsCommandInput | ListQueueQuickConnectsCommandInput | ListQueuesCommandInput | ListQuickConnectsCommandInput | ListRoutingProfileQueuesCommandInput | ListRoutingProfilesCommandInput | ListRulesCommandInput | ListSecurityKeysCommandInput | ListSecurityProfileApplicationsCommandInput | ListSecurityProfilePermissionsCommandInput | ListSecurityProfilesCommandInput | ListTagsForResourceCommandInput | ListTaskTemplatesCommandInput | ListTrafficDistributionGroupUsersCommandInput | ListTrafficDistributionGroupsCommandInput | ListUseCasesCommandInput | ListUserHierarchyGroupsCommandInput | ListUsersCommandInput | ListViewVersionsCommandInput | ListViewsCommandInput | MonitorContactCommandInput | PutUserStatusCommandInput | ReleasePhoneNumberCommandInput | ReplicateInstanceCommandInput | ResumeContactRecordingCommandInput | SearchAvailablePhoneNumbersCommandInput | SearchHoursOfOperationsCommandInput | SearchPromptsCommandInput | SearchQueuesCommandInput | SearchQuickConnectsCommandInput | SearchResourceTagsCommandInput | SearchRoutingProfilesCommandInput | SearchSecurityProfilesCommandInput | SearchUsersCommandInput | SearchVocabulariesCommandInput | StartChatContactCommandInput | StartContactEvaluationCommandInput | StartContactRecordingCommandInput | StartContactStreamingCommandInput | StartOutboundVoiceContactCommandInput | StartTaskContactCommandInput | StopContactCommandInput | StopContactRecordingCommandInput | StopContactStreamingCommandInput | SubmitContactEvaluationCommandInput | SuspendContactRecordingCommandInput | TagResourceCommandInput | TransferContactCommandInput | UntagResourceCommandInput | UpdateAgentStatusCommandInput | UpdateContactAttributesCommandInput | UpdateContactCommandInput | UpdateContactEvaluationCommandInput | UpdateContactFlowContentCommandInput | UpdateContactFlowMetadataCommandInput | UpdateContactFlowModuleContentCommandInput | UpdateContactFlowModuleMetadataCommandInput | UpdateContactFlowNameCommandInput | UpdateContactScheduleCommandInput | UpdateEvaluationFormCommandInput | UpdateHoursOfOperationCommandInput | UpdateInstanceAttributeCommandInput | UpdateInstanceStorageConfigCommandInput | UpdateParticipantRoleConfigCommandInput | UpdatePhoneNumberCommandInput | UpdatePhoneNumberMetadataCommandInput | UpdatePromptCommandInput | UpdateQueueHoursOfOperationCommandInput | UpdateQueueMaxContactsCommandInput | UpdateQueueNameCommandInput | UpdateQueueOutboundCallerConfigCommandInput | UpdateQueueStatusCommandInput | UpdateQuickConnectConfigCommandInput | UpdateQuickConnectNameCommandInput | UpdateRoutingProfileAgentAvailabilityTimerCommandInput | UpdateRoutingProfileConcurrencyCommandInput | UpdateRoutingProfileDefaultOutboundQueueCommandInput | UpdateRoutingProfileNameCommandInput | UpdateRoutingProfileQueuesCommandInput | UpdateRuleCommandInput | UpdateSecurityProfileCommandInput | UpdateTaskTemplateCommandInput | UpdateTrafficDistributionCommandInput | UpdateUserHierarchyCommandInput | UpdateUserHierarchyGroupNameCommandInput | UpdateUserHierarchyStructureCommandInput | UpdateUserIdentityInfoCommandInput | UpdateUserPhoneConfigCommandInput | UpdateUserRoutingProfileCommandInput | UpdateUserSecurityProfilesCommandInput | UpdateViewContentCommandInput | UpdateViewMetadataCommandInput;
|
|
228
229
|
/**
|
|
229
230
|
* @public
|
|
230
231
|
*/
|
|
231
|
-
export type ServiceOutputTypes = ActivateEvaluationFormCommandOutput | AssociateApprovedOriginCommandOutput | AssociateBotCommandOutput | AssociateDefaultVocabularyCommandOutput | AssociateInstanceStorageConfigCommandOutput | AssociateLambdaFunctionCommandOutput | AssociateLexBotCommandOutput | AssociatePhoneNumberContactFlowCommandOutput | AssociateQueueQuickConnectsCommandOutput | AssociateRoutingProfileQueuesCommandOutput | AssociateSecurityKeyCommandOutput | AssociateTrafficDistributionGroupUserCommandOutput | ClaimPhoneNumberCommandOutput | CreateAgentStatusCommandOutput | CreateContactFlowCommandOutput | CreateContactFlowModuleCommandOutput | CreateEvaluationFormCommandOutput | CreateHoursOfOperationCommandOutput | CreateInstanceCommandOutput | CreateIntegrationAssociationCommandOutput | CreateParticipantCommandOutput | CreatePromptCommandOutput | CreateQueueCommandOutput | CreateQuickConnectCommandOutput | CreateRoutingProfileCommandOutput | CreateRuleCommandOutput | CreateSecurityProfileCommandOutput | CreateTaskTemplateCommandOutput | CreateTrafficDistributionGroupCommandOutput | CreateUseCaseCommandOutput | CreateUserCommandOutput | CreateUserHierarchyGroupCommandOutput | CreateViewCommandOutput | CreateViewVersionCommandOutput | CreateVocabularyCommandOutput | DeactivateEvaluationFormCommandOutput | DeleteContactEvaluationCommandOutput | DeleteContactFlowCommandOutput | DeleteContactFlowModuleCommandOutput | DeleteEvaluationFormCommandOutput | DeleteHoursOfOperationCommandOutput | DeleteInstanceCommandOutput | DeleteIntegrationAssociationCommandOutput | DeletePromptCommandOutput | DeleteQueueCommandOutput | DeleteQuickConnectCommandOutput | DeleteRoutingProfileCommandOutput | DeleteRuleCommandOutput | DeleteSecurityProfileCommandOutput | DeleteTaskTemplateCommandOutput | DeleteTrafficDistributionGroupCommandOutput | DeleteUseCaseCommandOutput | DeleteUserCommandOutput | DeleteUserHierarchyGroupCommandOutput | DeleteViewCommandOutput | DeleteViewVersionCommandOutput | DeleteVocabularyCommandOutput | DescribeAgentStatusCommandOutput | DescribeContactCommandOutput | DescribeContactEvaluationCommandOutput | DescribeContactFlowCommandOutput | DescribeContactFlowModuleCommandOutput | DescribeEvaluationFormCommandOutput | DescribeHoursOfOperationCommandOutput | DescribeInstanceAttributeCommandOutput | DescribeInstanceCommandOutput | DescribeInstanceStorageConfigCommandOutput | DescribePhoneNumberCommandOutput | DescribePromptCommandOutput | DescribeQueueCommandOutput | DescribeQuickConnectCommandOutput | DescribeRoutingProfileCommandOutput | DescribeRuleCommandOutput | DescribeSecurityProfileCommandOutput | DescribeTrafficDistributionGroupCommandOutput | DescribeUserCommandOutput | DescribeUserHierarchyGroupCommandOutput | DescribeUserHierarchyStructureCommandOutput | DescribeViewCommandOutput | DescribeVocabularyCommandOutput | DisassociateApprovedOriginCommandOutput | DisassociateBotCommandOutput | DisassociateInstanceStorageConfigCommandOutput | DisassociateLambdaFunctionCommandOutput | DisassociateLexBotCommandOutput | DisassociatePhoneNumberContactFlowCommandOutput | DisassociateQueueQuickConnectsCommandOutput | DisassociateRoutingProfileQueuesCommandOutput | DisassociateSecurityKeyCommandOutput | DisassociateTrafficDistributionGroupUserCommandOutput | DismissUserContactCommandOutput | GetContactAttributesCommandOutput | GetCurrentMetricDataCommandOutput | GetCurrentUserDataCommandOutput | GetFederationTokenCommandOutput | GetMetricDataCommandOutput | GetMetricDataV2CommandOutput | GetPromptFileCommandOutput | GetTaskTemplateCommandOutput | GetTrafficDistributionCommandOutput | ListAgentStatusesCommandOutput | ListApprovedOriginsCommandOutput | ListBotsCommandOutput | ListContactEvaluationsCommandOutput | ListContactFlowModulesCommandOutput | ListContactFlowsCommandOutput | ListContactReferencesCommandOutput | ListDefaultVocabulariesCommandOutput | ListEvaluationFormVersionsCommandOutput | ListEvaluationFormsCommandOutput | ListHoursOfOperationsCommandOutput | ListInstanceAttributesCommandOutput | ListInstanceStorageConfigsCommandOutput | ListInstancesCommandOutput | ListIntegrationAssociationsCommandOutput | ListLambdaFunctionsCommandOutput | ListLexBotsCommandOutput | ListPhoneNumbersCommandOutput | ListPhoneNumbersV2CommandOutput | ListPromptsCommandOutput | ListQueueQuickConnectsCommandOutput | ListQueuesCommandOutput | ListQuickConnectsCommandOutput | ListRoutingProfileQueuesCommandOutput | ListRoutingProfilesCommandOutput | ListRulesCommandOutput | ListSecurityKeysCommandOutput | ListSecurityProfileApplicationsCommandOutput | ListSecurityProfilePermissionsCommandOutput | ListSecurityProfilesCommandOutput | ListTagsForResourceCommandOutput | ListTaskTemplatesCommandOutput | ListTrafficDistributionGroupUsersCommandOutput | ListTrafficDistributionGroupsCommandOutput | ListUseCasesCommandOutput | ListUserHierarchyGroupsCommandOutput | ListUsersCommandOutput | ListViewVersionsCommandOutput | ListViewsCommandOutput | MonitorContactCommandOutput | PutUserStatusCommandOutput | ReleasePhoneNumberCommandOutput | ReplicateInstanceCommandOutput | ResumeContactRecordingCommandOutput | SearchAvailablePhoneNumbersCommandOutput | SearchHoursOfOperationsCommandOutput | SearchPromptsCommandOutput | SearchQueuesCommandOutput | SearchQuickConnectsCommandOutput | SearchResourceTagsCommandOutput | SearchRoutingProfilesCommandOutput | SearchSecurityProfilesCommandOutput | SearchUsersCommandOutput | SearchVocabulariesCommandOutput | StartChatContactCommandOutput | StartContactEvaluationCommandOutput | StartContactRecordingCommandOutput | StartContactStreamingCommandOutput | StartOutboundVoiceContactCommandOutput | StartTaskContactCommandOutput | StopContactCommandOutput | StopContactRecordingCommandOutput | StopContactStreamingCommandOutput | SubmitContactEvaluationCommandOutput | SuspendContactRecordingCommandOutput | TagResourceCommandOutput | TransferContactCommandOutput | UntagResourceCommandOutput | UpdateAgentStatusCommandOutput | UpdateContactAttributesCommandOutput | UpdateContactCommandOutput | UpdateContactEvaluationCommandOutput | UpdateContactFlowContentCommandOutput | UpdateContactFlowMetadataCommandOutput | UpdateContactFlowModuleContentCommandOutput | UpdateContactFlowModuleMetadataCommandOutput | UpdateContactFlowNameCommandOutput | UpdateContactScheduleCommandOutput | UpdateEvaluationFormCommandOutput | UpdateHoursOfOperationCommandOutput | UpdateInstanceAttributeCommandOutput | UpdateInstanceStorageConfigCommandOutput | UpdateParticipantRoleConfigCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePromptCommandOutput | UpdateQueueHoursOfOperationCommandOutput | UpdateQueueMaxContactsCommandOutput | UpdateQueueNameCommandOutput | UpdateQueueOutboundCallerConfigCommandOutput | UpdateQueueStatusCommandOutput | UpdateQuickConnectConfigCommandOutput | UpdateQuickConnectNameCommandOutput | UpdateRoutingProfileAgentAvailabilityTimerCommandOutput | UpdateRoutingProfileConcurrencyCommandOutput | UpdateRoutingProfileDefaultOutboundQueueCommandOutput | UpdateRoutingProfileNameCommandOutput | UpdateRoutingProfileQueuesCommandOutput | UpdateRuleCommandOutput | UpdateSecurityProfileCommandOutput | UpdateTaskTemplateCommandOutput | UpdateTrafficDistributionCommandOutput | UpdateUserHierarchyCommandOutput | UpdateUserHierarchyGroupNameCommandOutput | UpdateUserHierarchyStructureCommandOutput | UpdateUserIdentityInfoCommandOutput | UpdateUserPhoneConfigCommandOutput | UpdateUserRoutingProfileCommandOutput | UpdateUserSecurityProfilesCommandOutput | UpdateViewContentCommandOutput | UpdateViewMetadataCommandOutput;
|
|
232
|
+
export type ServiceOutputTypes = ActivateEvaluationFormCommandOutput | AssociateApprovedOriginCommandOutput | AssociateBotCommandOutput | AssociateDefaultVocabularyCommandOutput | AssociateInstanceStorageConfigCommandOutput | AssociateLambdaFunctionCommandOutput | AssociateLexBotCommandOutput | AssociatePhoneNumberContactFlowCommandOutput | AssociateQueueQuickConnectsCommandOutput | AssociateRoutingProfileQueuesCommandOutput | AssociateSecurityKeyCommandOutput | AssociateTrafficDistributionGroupUserCommandOutput | ClaimPhoneNumberCommandOutput | CreateAgentStatusCommandOutput | CreateContactFlowCommandOutput | CreateContactFlowModuleCommandOutput | CreateEvaluationFormCommandOutput | CreateHoursOfOperationCommandOutput | CreateInstanceCommandOutput | CreateIntegrationAssociationCommandOutput | CreateParticipantCommandOutput | CreatePromptCommandOutput | CreateQueueCommandOutput | CreateQuickConnectCommandOutput | CreateRoutingProfileCommandOutput | CreateRuleCommandOutput | CreateSecurityProfileCommandOutput | CreateTaskTemplateCommandOutput | CreateTrafficDistributionGroupCommandOutput | CreateUseCaseCommandOutput | CreateUserCommandOutput | CreateUserHierarchyGroupCommandOutput | CreateViewCommandOutput | CreateViewVersionCommandOutput | CreateVocabularyCommandOutput | DeactivateEvaluationFormCommandOutput | DeleteContactEvaluationCommandOutput | DeleteContactFlowCommandOutput | DeleteContactFlowModuleCommandOutput | DeleteEvaluationFormCommandOutput | DeleteHoursOfOperationCommandOutput | DeleteInstanceCommandOutput | DeleteIntegrationAssociationCommandOutput | DeletePromptCommandOutput | DeleteQueueCommandOutput | DeleteQuickConnectCommandOutput | DeleteRoutingProfileCommandOutput | DeleteRuleCommandOutput | DeleteSecurityProfileCommandOutput | DeleteTaskTemplateCommandOutput | DeleteTrafficDistributionGroupCommandOutput | DeleteUseCaseCommandOutput | DeleteUserCommandOutput | DeleteUserHierarchyGroupCommandOutput | DeleteViewCommandOutput | DeleteViewVersionCommandOutput | DeleteVocabularyCommandOutput | DescribeAgentStatusCommandOutput | DescribeContactCommandOutput | DescribeContactEvaluationCommandOutput | DescribeContactFlowCommandOutput | DescribeContactFlowModuleCommandOutput | DescribeEvaluationFormCommandOutput | DescribeHoursOfOperationCommandOutput | DescribeInstanceAttributeCommandOutput | DescribeInstanceCommandOutput | DescribeInstanceStorageConfigCommandOutput | DescribePhoneNumberCommandOutput | DescribePromptCommandOutput | DescribeQueueCommandOutput | DescribeQuickConnectCommandOutput | DescribeRoutingProfileCommandOutput | DescribeRuleCommandOutput | DescribeSecurityProfileCommandOutput | DescribeTrafficDistributionGroupCommandOutput | DescribeUserCommandOutput | DescribeUserHierarchyGroupCommandOutput | DescribeUserHierarchyStructureCommandOutput | DescribeViewCommandOutput | DescribeVocabularyCommandOutput | DisassociateApprovedOriginCommandOutput | DisassociateBotCommandOutput | DisassociateInstanceStorageConfigCommandOutput | DisassociateLambdaFunctionCommandOutput | DisassociateLexBotCommandOutput | DisassociatePhoneNumberContactFlowCommandOutput | DisassociateQueueQuickConnectsCommandOutput | DisassociateRoutingProfileQueuesCommandOutput | DisassociateSecurityKeyCommandOutput | DisassociateTrafficDistributionGroupUserCommandOutput | DismissUserContactCommandOutput | GetContactAttributesCommandOutput | GetCurrentMetricDataCommandOutput | GetCurrentUserDataCommandOutput | GetFederationTokenCommandOutput | GetMetricDataCommandOutput | GetMetricDataV2CommandOutput | GetPromptFileCommandOutput | GetTaskTemplateCommandOutput | GetTrafficDistributionCommandOutput | ListAgentStatusesCommandOutput | ListApprovedOriginsCommandOutput | ListBotsCommandOutput | ListContactEvaluationsCommandOutput | ListContactFlowModulesCommandOutput | ListContactFlowsCommandOutput | ListContactReferencesCommandOutput | ListDefaultVocabulariesCommandOutput | ListEvaluationFormVersionsCommandOutput | ListEvaluationFormsCommandOutput | ListHoursOfOperationsCommandOutput | ListInstanceAttributesCommandOutput | ListInstanceStorageConfigsCommandOutput | ListInstancesCommandOutput | ListIntegrationAssociationsCommandOutput | ListLambdaFunctionsCommandOutput | ListLexBotsCommandOutput | ListPhoneNumbersCommandOutput | ListPhoneNumbersV2CommandOutput | ListPromptsCommandOutput | ListQueueQuickConnectsCommandOutput | ListQueuesCommandOutput | ListQuickConnectsCommandOutput | ListRoutingProfileQueuesCommandOutput | ListRoutingProfilesCommandOutput | ListRulesCommandOutput | ListSecurityKeysCommandOutput | ListSecurityProfileApplicationsCommandOutput | ListSecurityProfilePermissionsCommandOutput | ListSecurityProfilesCommandOutput | ListTagsForResourceCommandOutput | ListTaskTemplatesCommandOutput | ListTrafficDistributionGroupUsersCommandOutput | ListTrafficDistributionGroupsCommandOutput | ListUseCasesCommandOutput | ListUserHierarchyGroupsCommandOutput | ListUsersCommandOutput | ListViewVersionsCommandOutput | ListViewsCommandOutput | MonitorContactCommandOutput | PutUserStatusCommandOutput | ReleasePhoneNumberCommandOutput | ReplicateInstanceCommandOutput | ResumeContactRecordingCommandOutput | SearchAvailablePhoneNumbersCommandOutput | SearchHoursOfOperationsCommandOutput | SearchPromptsCommandOutput | SearchQueuesCommandOutput | SearchQuickConnectsCommandOutput | SearchResourceTagsCommandOutput | SearchRoutingProfilesCommandOutput | SearchSecurityProfilesCommandOutput | SearchUsersCommandOutput | SearchVocabulariesCommandOutput | StartChatContactCommandOutput | StartContactEvaluationCommandOutput | StartContactRecordingCommandOutput | StartContactStreamingCommandOutput | StartOutboundVoiceContactCommandOutput | StartTaskContactCommandOutput | StopContactCommandOutput | StopContactRecordingCommandOutput | StopContactStreamingCommandOutput | SubmitContactEvaluationCommandOutput | SuspendContactRecordingCommandOutput | TagResourceCommandOutput | TransferContactCommandOutput | UntagResourceCommandOutput | UpdateAgentStatusCommandOutput | UpdateContactAttributesCommandOutput | UpdateContactCommandOutput | UpdateContactEvaluationCommandOutput | UpdateContactFlowContentCommandOutput | UpdateContactFlowMetadataCommandOutput | UpdateContactFlowModuleContentCommandOutput | UpdateContactFlowModuleMetadataCommandOutput | UpdateContactFlowNameCommandOutput | UpdateContactScheduleCommandOutput | UpdateEvaluationFormCommandOutput | UpdateHoursOfOperationCommandOutput | UpdateInstanceAttributeCommandOutput | UpdateInstanceStorageConfigCommandOutput | UpdateParticipantRoleConfigCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePhoneNumberMetadataCommandOutput | UpdatePromptCommandOutput | UpdateQueueHoursOfOperationCommandOutput | UpdateQueueMaxContactsCommandOutput | UpdateQueueNameCommandOutput | UpdateQueueOutboundCallerConfigCommandOutput | UpdateQueueStatusCommandOutput | UpdateQuickConnectConfigCommandOutput | UpdateQuickConnectNameCommandOutput | UpdateRoutingProfileAgentAvailabilityTimerCommandOutput | UpdateRoutingProfileConcurrencyCommandOutput | UpdateRoutingProfileDefaultOutboundQueueCommandOutput | UpdateRoutingProfileNameCommandOutput | UpdateRoutingProfileQueuesCommandOutput | UpdateRuleCommandOutput | UpdateSecurityProfileCommandOutput | UpdateTaskTemplateCommandOutput | UpdateTrafficDistributionCommandOutput | UpdateUserHierarchyCommandOutput | UpdateUserHierarchyGroupNameCommandOutput | UpdateUserHierarchyStructureCommandOutput | UpdateUserIdentityInfoCommandOutput | UpdateUserPhoneConfigCommandOutput | UpdateUserRoutingProfileCommandOutput | UpdateUserSecurityProfilesCommandOutput | UpdateViewContentCommandOutput | UpdateViewMetadataCommandOutput;
|
|
232
233
|
/**
|
|
233
234
|
* @public
|
|
234
235
|
*/
|
|
@@ -368,9 +369,9 @@ export interface ConnectClientResolvedConfig extends ConnectClientResolvedConfig
|
|
|
368
369
|
* contact routing. You can also resolve customer issues more efficiently by getting customers in
|
|
369
370
|
* touch with the appropriate agents.</p>
|
|
370
371
|
* <p>There are limits to the number of Amazon Connect resources that you can create. There
|
|
371
|
-
* are also limits to the number of requests that you can make per second. For more information,
|
|
372
|
-
*
|
|
373
|
-
* Guide</i>.</p>
|
|
372
|
+
* are also limits to the number of requests that you can make per second. For more information,
|
|
373
|
+
* seeP98941055 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service
|
|
374
|
+
* Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
374
375
|
* <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
|
|
375
376
|
* 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>
|
|
376
377
|
*/
|
|
@@ -25,7 +25,7 @@ export interface CreateTrafficDistributionGroupCommandOutput extends CreateTraff
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Creates a traffic distribution group given an Amazon Connect instance that has been replicated. </p>
|
|
27
27
|
* <note>
|
|
28
|
-
* <p>
|
|
28
|
+
* <p>The <code>SignInConfig</code> distribution is available only on a
|
|
29
29
|
* default <code>TrafficDistributionGroup</code> (see the <code>IsDefault</code> parameter in the
|
|
30
30
|
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html">TrafficDistributionGroup</a>
|
|
31
31
|
* data type). If you call
|
|
@@ -24,6 +24,12 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Creates a user account for the specified Amazon Connect instance.</p>
|
|
27
|
+
* <important>
|
|
28
|
+
* <p>Certain <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UserIdentityInfo.html">UserIdentityInfo</a> parameters
|
|
29
|
+
* are required in some situations. For example, <code>Email</code> is required if you are using
|
|
30
|
+
* SAML for identity management. <code>FirstName</code> and <code>LastName</code> are required if
|
|
31
|
+
* you are using Amazon Connect or SAML for identity management.</p>
|
|
32
|
+
* </important>
|
|
27
33
|
* <p>For information about how to create user accounts using the Amazon Connect console, see
|
|
28
34
|
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html">Add
|
|
29
35
|
* Users</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
@@ -23,7 +23,13 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Retrieves a token for federation
|
|
26
|
+
* <p>Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is
|
|
27
|
+
* for the Amazon Connect user which corresponds to the IAM credentials that were
|
|
28
|
+
* used to invoke this action. </p>
|
|
29
|
+
* <p>For more information about how SAML sign-in works in Amazon Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/configure-saml.html ">Configure SAML with
|
|
30
|
+
* IAM for Amazon Connect in the <i>Amazon Connect Administrator
|
|
31
|
+
* Guide</i>.</a>
|
|
32
|
+
* </p>
|
|
27
33
|
* <note>
|
|
28
34
|
* <p>This API doesn't support root users. If you try to invoke GetFederationToken with root
|
|
29
35
|
* credentials, an error message similar to the following one appears: </p>
|
|
@@ -26,6 +26,15 @@ export interface GetMetricDataCommandOutput extends GetMetricDataResponse, __Met
|
|
|
26
26
|
* <p>Gets historical metric data from the specified Amazon Connect instance.</p>
|
|
27
27
|
* <p>For a description of each historical metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical Metrics
|
|
28
28
|
* Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
29
|
+
* <note>
|
|
30
|
+
* <p>We recommend using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html">GetMetricDataV2</a> API. It
|
|
31
|
+
* provides more flexibility, features, and the ability to query longer time ranges than
|
|
32
|
+
* <code>GetMetricData</code>. Use it to retrieve historical agent and contact metrics for the
|
|
33
|
+
* last 3 months, at varying intervals. You can also use it to build custom dashboards to measure
|
|
34
|
+
* historical queue and agent performance. For example, you can track the number of incoming
|
|
35
|
+
* contacts for the last 7 days, with data split by day, to see how contact volume changed per day
|
|
36
|
+
* of the week.</p>
|
|
37
|
+
* </note>
|
|
29
38
|
* @example
|
|
30
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
40
|
* ```javascript
|
|
@@ -24,7 +24,7 @@ export interface SearchUsersCommandOutput extends SearchUsersResponse, __Metadat
|
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
26
|
* @public
|
|
27
|
-
* <p>Searches users in an Amazon Connect instance, with optional filtering
|
|
27
|
+
* <p>Searches users in an Amazon Connect instance, with optional filtering. </p>
|
|
28
28
|
* <note>
|
|
29
29
|
* <p>
|
|
30
30
|
* <code>AfterContactWorkTimeLimit</code> is returned in milliseconds. </p>
|
|
@@ -23,7 +23,57 @@ export interface StartTaskContactCommandOutput extends StartTaskContactResponse,
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Initiates a flow to start a new task
|
|
26
|
+
* <p>Initiates a flow to start a new task contact. For more information about task contacts, see
|
|
27
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html">Concepts: Tasks in
|
|
28
|
+
* Amazon Connect</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
|
|
29
|
+
* <p>When using <code>PreviousContactId</code> and <code>RelatedContactId</code> input
|
|
30
|
+
* parameters, note the following:</p>
|
|
31
|
+
* <ul>
|
|
32
|
+
* <li>
|
|
33
|
+
* <p>
|
|
34
|
+
* <code>PreviousContactId</code>
|
|
35
|
+
* </p>
|
|
36
|
+
* <ul>
|
|
37
|
+
* <li>
|
|
38
|
+
* <p>Any updates to user-defined task contact attributes on any contact linked through the
|
|
39
|
+
* same <code>PreviousContactId</code> will affect every contact in the chain.</p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts
|
|
43
|
+
* can be created that share the same <code>PreviousContactId</code>.</p>
|
|
44
|
+
* </li>
|
|
45
|
+
* </ul>
|
|
46
|
+
* </li>
|
|
47
|
+
* <li>
|
|
48
|
+
* <p>
|
|
49
|
+
* <code>RelatedContactId</code>
|
|
50
|
+
* </p>
|
|
51
|
+
* <ul>
|
|
52
|
+
* <li>
|
|
53
|
+
* <p>Copies contact attributes from the related task contact to the new contact.</p>
|
|
54
|
+
* </li>
|
|
55
|
+
* <li>
|
|
56
|
+
* <p>Any update on attributes in a new task contact does not update attributes on previous
|
|
57
|
+
* contact.</p>
|
|
58
|
+
* </li>
|
|
59
|
+
* <li>
|
|
60
|
+
* <p>There’s no limit on the number of task contacts that can be created that use the same
|
|
61
|
+
* <code>RelatedContactId</code>.</p>
|
|
62
|
+
* </li>
|
|
63
|
+
* </ul>
|
|
64
|
+
* </li>
|
|
65
|
+
* </ul>
|
|
66
|
+
* <p>In addition, when calling StartTaskContact include only one of these parameters:
|
|
67
|
+
* <code>ContactFlowID</code>, <code>QuickConnectID</code>, or <code>TaskTemplateID</code>. Only
|
|
68
|
+
* one parameter is required as long as the task template has a flow configured to run it. If more
|
|
69
|
+
* than one parameter is specified, or only the <code>TaskTemplateID</code> is specified but it does
|
|
70
|
+
* not have a flow configured, the request returns an error because Amazon Connect cannot
|
|
71
|
+
* identify the unique flow to run when the task is created.</p>
|
|
72
|
+
* <p>A <code>ServiceQuotaExceededException</code> occurs when the number of open tasks exceeds
|
|
73
|
+
* the active tasks quota or there are already 12 tasks referencing the same
|
|
74
|
+
* <code>PreviousContactId</code>. For more information about service quotas for task contacts, see
|
|
75
|
+
* <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
|
|
76
|
+
* Guide</i>. </p>
|
|
27
77
|
* @example
|
|
28
78
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
79
|
* ```javascript
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
5
|
+
import { UpdatePhoneNumberMetadataRequest } from "../models/models_2";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdatePhoneNumberMetadataCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdatePhoneNumberMetadataCommandInput extends UpdatePhoneNumberMetadataRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdatePhoneNumberMetadataCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdatePhoneNumberMetadataCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Updates a phone number’s metadata.</p>
|
|
27
|
+
* <important>
|
|
28
|
+
* <p>To verify the status of a previous UpdatePhoneNumberMetadata operation, call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html">DescribePhoneNumber</a> API.</p>
|
|
29
|
+
* </important>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { ConnectClient, UpdatePhoneNumberMetadataCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
34
|
+
* // const { ConnectClient, UpdatePhoneNumberMetadataCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
35
|
+
* const client = new ConnectClient(config);
|
|
36
|
+
* const input = { // UpdatePhoneNumberMetadataRequest
|
|
37
|
+
* PhoneNumberId: "STRING_VALUE", // required
|
|
38
|
+
* PhoneNumberDescription: "STRING_VALUE",
|
|
39
|
+
* ClientToken: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new UpdatePhoneNumberMetadataCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param UpdatePhoneNumberMetadataCommandInput - {@link UpdatePhoneNumberMetadataCommandInput}
|
|
48
|
+
* @returns {@link UpdatePhoneNumberMetadataCommandOutput}
|
|
49
|
+
* @see {@link UpdatePhoneNumberMetadataCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link UpdatePhoneNumberMetadataCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
54
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link IdempotencyException} (client fault)
|
|
57
|
+
* <p>An entity with the same name already exists.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
60
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
63
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
66
|
+
* <p>The request is not valid.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ResourceInUseException} (client fault)
|
|
69
|
+
* <p>That resource is already in use. Please try another.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p>The specified resource was not found.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ConnectServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
79
|
+
*
|
|
80
|
+
*/
|
|
81
|
+
export declare class UpdatePhoneNumberMetadataCommand extends $Command<UpdatePhoneNumberMetadataCommandInput, UpdatePhoneNumberMetadataCommandOutput, ConnectClientResolvedConfig> {
|
|
82
|
+
readonly input: UpdatePhoneNumberMetadataCommandInput;
|
|
83
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
84
|
+
/**
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
constructor(input: UpdatePhoneNumberMetadataCommandInput);
|
|
88
|
+
/**
|
|
89
|
+
* @internal
|
|
90
|
+
*/
|
|
91
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePhoneNumberMetadataCommandInput, UpdatePhoneNumberMetadataCommandOutput>;
|
|
92
|
+
/**
|
|
93
|
+
* @internal
|
|
94
|
+
*/
|
|
95
|
+
private serialize;
|
|
96
|
+
/**
|
|
97
|
+
* @internal
|
|
98
|
+
*/
|
|
99
|
+
private deserialize;
|
|
100
|
+
}
|
|
@@ -25,7 +25,7 @@ export interface UpdateTrafficDistributionCommandOutput extends UpdateTrafficDis
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Updates the traffic distribution for a given traffic distribution group. </p>
|
|
27
27
|
* <note>
|
|
28
|
-
* <p>
|
|
28
|
+
* <p>The <code>SignInConfig</code> distribution is available only on a
|
|
29
29
|
* default <code>TrafficDistributionGroup</code> (see the <code>IsDefault</code> parameter in the
|
|
30
30
|
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html">TrafficDistributionGroup</a>
|
|
31
31
|
* data type). If you call
|
|
@@ -182,6 +182,7 @@ export * from "./UpdateInstanceAttributeCommand";
|
|
|
182
182
|
export * from "./UpdateInstanceStorageConfigCommand";
|
|
183
183
|
export * from "./UpdateParticipantRoleConfigCommand";
|
|
184
184
|
export * from "./UpdatePhoneNumberCommand";
|
|
185
|
+
export * from "./UpdatePhoneNumberMetadataCommand";
|
|
185
186
|
export * from "./UpdatePromptCommand";
|
|
186
187
|
export * from "./UpdateQueueHoursOfOperationCommand";
|
|
187
188
|
export * from "./UpdateQueueMaxContactsCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -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
|
-
*
|
|
10
|
-
* Guide</i>.</p>
|
|
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>
|
|
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
|
*
|
|
@@ -1180,7 +1180,7 @@ export interface CreateContactFlowRequest {
|
|
|
1180
1180
|
/**
|
|
1181
1181
|
* @public
|
|
1182
1182
|
* <p>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
|
|
1183
|
-
*
|
|
1183
|
+
* flow in Amazon Connect Flow language</a>. </p>
|
|
1184
1184
|
* <p>Length Constraints: Minimum length of 1. Maximum length of 256000.</p>
|
|
1185
1185
|
*/
|
|
1186
1186
|
Content: string | undefined;
|
|
@@ -1254,7 +1254,8 @@ export interface CreateContactFlowModuleRequest {
|
|
|
1254
1254
|
Description?: string;
|
|
1255
1255
|
/**
|
|
1256
1256
|
* @public
|
|
1257
|
-
* <p>The content of the flow
|
|
1257
|
+
* <p>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
|
|
1258
|
+
* flow in Amazon Connect Flow language</a>. </p>
|
|
1258
1259
|
*/
|
|
1259
1260
|
Content: string | undefined;
|
|
1260
1261
|
/**
|
|
@@ -2791,7 +2792,8 @@ export interface Application {
|
|
|
2791
2792
|
Namespace?: string;
|
|
2792
2793
|
/**
|
|
2793
2794
|
* @public
|
|
2794
|
-
* <p>The permissions that the agent is granted on the application. Only the <code>ACCESS</code>
|
|
2795
|
+
* <p>The permissions that the agent is granted on the application. Only the <code>ACCESS</code>
|
|
2796
|
+
* permission is supported.</p>
|
|
2795
2797
|
*/
|
|
2796
2798
|
ApplicationPermissions?: string[];
|
|
2797
2799
|
}
|
|
@@ -4693,7 +4695,8 @@ export interface ContactFlow {
|
|
|
4693
4695
|
/**
|
|
4694
4696
|
* @public
|
|
4695
4697
|
* <p>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
|
|
4696
|
-
*
|
|
4698
|
+
* flow in Amazon Connect Flow language</a>. </p>
|
|
4699
|
+
* <p>Length Constraints: Minimum length of 1. Maximum length of 256000.</p>
|
|
4697
4700
|
*/
|
|
4698
4701
|
Content?: string;
|
|
4699
4702
|
/**
|
|
@@ -4774,8 +4777,7 @@ export interface ContactFlowModule {
|
|
|
4774
4777
|
/**
|
|
4775
4778
|
* @public
|
|
4776
4779
|
* <p>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
|
|
4777
|
-
*
|
|
4778
|
-
* <p>Length Constraints: Minimum length of 1. Maximum length of 256000.</p>
|
|
4780
|
+
* flow in Amazon Connect Flow language</a>. </p>
|
|
4779
4781
|
*/
|
|
4780
4782
|
Content?: string;
|
|
4781
4783
|
/**
|
|
@@ -5383,20 +5385,17 @@ export type PhoneNumberWorkflowStatus = (typeof PhoneNumberWorkflowStatus)[keyof
|
|
|
5383
5385
|
* <ul>
|
|
5384
5386
|
* <li>
|
|
5385
5387
|
* <p>
|
|
5386
|
-
* <code>CLAIMED</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/
|
|
5387
|
-
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html">UpdatePhoneNumber</a> operation succeeded.</p>
|
|
5388
|
+
* <code>CLAIMED</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html">ClaimPhoneNumber</a> or <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html">UpdatePhoneNumber</a> operation succeeded.</p>
|
|
5388
5389
|
* </li>
|
|
5389
5390
|
* <li>
|
|
5390
5391
|
* <p>
|
|
5391
|
-
* <code>IN_PROGRESS</code> means a <a href="https://docs.aws.amazon.com/connect/latest/APIReference/
|
|
5392
|
-
*
|
|
5393
|
-
*
|
|
5394
|
-
* completed.</p>
|
|
5392
|
+
* <code>IN_PROGRESS</code> means a <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html">ClaimPhoneNumber</a>, <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html">UpdatePhoneNumber</a>, or <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.html">UpdatePhoneNumberMetadata</a> operation is still in progress and has not yet completed.
|
|
5393
|
+
* You can call <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html">DescribePhoneNumber</a> at
|
|
5394
|
+
* a later time to verify if the previous operation has completed.</p>
|
|
5395
5395
|
* </li>
|
|
5396
5396
|
* <li>
|
|
5397
5397
|
* <p>
|
|
5398
|
-
* <code>FAILED</code> indicates that the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/
|
|
5399
|
-
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html">UpdatePhoneNumber</a> operation has failed. It will include a message indicating the
|
|
5398
|
+
* <code>FAILED</code> indicates that the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html">ClaimPhoneNumber</a> or <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html">UpdatePhoneNumber</a> operation has failed. It will include a message indicating the
|
|
5400
5399
|
* failure reason. A common reason for a failure may be that the <code>TargetArn</code> value you
|
|
5401
5400
|
* are claiming or updating a phone number to has reached its limit of total claimed numbers. If
|
|
5402
5401
|
* you received a <code>FAILED</code> status from a <code>ClaimPhoneNumber</code> API call, you
|
|
@@ -5485,20 +5484,17 @@ export interface ClaimedPhoneNumberSummary {
|
|
|
5485
5484
|
* <ul>
|
|
5486
5485
|
* <li>
|
|
5487
5486
|
* <p>
|
|
5488
|
-
* <code>CLAIMED</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/
|
|
5489
|
-
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html">UpdatePhoneNumber</a> operation succeeded.</p>
|
|
5487
|
+
* <code>CLAIMED</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html">ClaimPhoneNumber</a> or <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html">UpdatePhoneNumber</a> operation succeeded.</p>
|
|
5490
5488
|
* </li>
|
|
5491
5489
|
* <li>
|
|
5492
5490
|
* <p>
|
|
5493
|
-
* <code>IN_PROGRESS</code> means a <a href="https://docs.aws.amazon.com/connect/latest/APIReference/
|
|
5494
|
-
*
|
|
5495
|
-
*
|
|
5496
|
-
* completed.</p>
|
|
5491
|
+
* <code>IN_PROGRESS</code> means a <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html">ClaimPhoneNumber</a>, <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html">UpdatePhoneNumber</a>, or <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.html">UpdatePhoneNumberMetadata</a> operation is still in progress and has not yet completed.
|
|
5492
|
+
* You can call <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html">DescribePhoneNumber</a> at
|
|
5493
|
+
* a later time to verify if the previous operation has completed.</p>
|
|
5497
5494
|
* </li>
|
|
5498
5495
|
* <li>
|
|
5499
5496
|
* <p>
|
|
5500
|
-
* <code>FAILED</code> indicates that the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/
|
|
5501
|
-
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html">UpdatePhoneNumber</a> operation has failed. It will include a message indicating the
|
|
5497
|
+
* <code>FAILED</code> indicates that the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html">ClaimPhoneNumber</a> or <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html">UpdatePhoneNumber</a> operation has failed. It will include a message indicating the
|
|
5502
5498
|
* failure reason. A common reason for a failure may be that the <code>TargetArn</code> value you
|
|
5503
5499
|
* are claiming or updating a phone number to has reached its limit of total claimed numbers. If
|
|
5504
5500
|
* you received a <code>FAILED</code> status from a <code>ClaimPhoneNumber</code> API call, you
|
|
@@ -6063,7 +6059,7 @@ export interface TrafficDistributionGroup {
|
|
|
6063
6059
|
* </li>
|
|
6064
6060
|
* <li>
|
|
6065
6061
|
* <p>
|
|
6066
|
-
* <code>UPDATE_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/
|
|
6062
|
+
* <code>UPDATE_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistribution.html">UpdateTrafficDistribution</a> operation is still in progress and has not yet
|
|
6067
6063
|
* completed.</p>
|
|
6068
6064
|
* </li>
|
|
6069
6065
|
* </ul>
|
|
@@ -6081,12 +6077,10 @@ export interface TrafficDistributionGroup {
|
|
|
6081
6077
|
* <code>DeleteTrafficDistributionGroup</code> API. The default traffic distribution group is deleted as
|
|
6082
6078
|
* part of the process for deleting a replica.</p>
|
|
6083
6079
|
* <note>
|
|
6084
|
-
* <p>
|
|
6085
|
-
*
|
|
6086
|
-
* <a
|
|
6087
|
-
*
|
|
6088
|
-
* <code>UpdateTrafficDistribution</code> with a modified <code>SignInConfig</code> and a non-default <code>TrafficDistributionGroup</code>,
|
|
6089
|
-
* an <code>InvalidRequestException</code> is returned.</p>
|
|
6080
|
+
* <p>The <code>SignInConfig</code> distribution is available only on the default
|
|
6081
|
+
* <code>TrafficDistributionGroup</code>. If you call <code>UpdateTrafficDistribution</code> with
|
|
6082
|
+
* a modified <code>SignInConfig</code> and a non-default <code>TrafficDistributionGroup</code>, an
|
|
6083
|
+
* <code>InvalidRequestException</code> is returned.</p>
|
|
6090
6084
|
* </note>
|
|
6091
6085
|
*/
|
|
6092
6086
|
IsDefault?: boolean;
|